Documentation
¶
Index ¶
- func DeepCopy(value any) any
- func FinalizeResult(logger *log.Logger, result error, isSetup bool) int
- func IsNil[T any](value T) bool
- func Max[T itf.Comparable](a, b T) T
- func Min[T itf.Comparable](a, b T) T
- func RecoverFromPanic(logger *log.Logger)
- func RunInPowerShell(program string, args ...string) func() error
- func SplitIntoGroups[T any](slice []T, n int) ([][]T, error)
- type ExitCode
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DeepCopy ¶
DeepCopy is a function that performs a deep copy of a given value.
Parameters:
- value: The value to copy.
Return:
- any: A deep copy of the input value.
func FinalizeResult ¶ added in v0.2.20
FinalizeResult is a function that finalizes the result of a program and logs the error message to a log file.
If an error occurs during the execution of the program, this function will log the error message to the specified log file and exit the program with the Error exit code. If no error occurs, the function will log a success message to the log file and exit the program with the Success exit code.
Parameters:
- logger: The logger to use for logging the error message. If nil, the error message is logged to the console.
- result: The result of the program. If nil, the program is considered to have finished successfully.
Return:
- int: The exit code of the program.
Example:
var logger *ers.FileLogger
func main() {
// Set up the logger
var err error
logger, err = ers.NewFileLogger("log.txt")
if err != nil {
os.Exit(FinalizeResult(logger, err, true))
}
defer logger.Close()
defer RecoverFromPanic(logger) // handle panics gracefully
os.Exit(FinalizeResult(logger, mainBody(), false)) // handle errors gracefully
}
func mainBody() error {
// Perform the main logic of the program
}
func IsNil ¶ added in v0.2.9
IsNil is a function that checks if a value is nil.
Parameters:
- value: The value to check.
Return:
- bool: True if the value is nil, false otherwise.
func Max ¶ added in v0.2.9
func Max[T itf.Comparable](a, b T) T
Max is a function that takes two parameters, a and b, of any type T that implements the Comparable interface and returns the larger of the two values.
Parameters:
- a, b: The two values to compare.
Return:
- T: The larger of the two values.
func Min ¶ added in v0.2.9
func Min[T itf.Comparable](a, b T) T
Min is a function that takes two parameters, a and b, of any type T that implements the Comparable interface and returns the smaller of the two values.
Parameters:
- a, b: The two values to compare.
Return:
- T: The smaller of the two values.
func RecoverFromPanic ¶ added in v0.2.20
RecoverFromPanic is a function that recovers from a panic and logs the error message to a log file.
If a panic occurs during the execution of the program, this function will recover from the panic, log the error message to the specified log file, and exit the program with the Panic exit code.
Parameters:
- logger: The logger to use for logging the error message. If nil, the error message is logged to the console.
func RunInPowerShell ¶ added in v0.2.20
RunInPowerShell is a function that returns a function that runs a program in a new PowerShell process.
Upon calling the returned function, a new PowerShell process is started with the specified program and arguments. The function returns an error if the process cannot be started.
Parameters:
- program: The path to the program to run.
- args: The arguments to pass to the program.
Return:
- func() error: A function that runs the program in a new PowerShell process.
func SplitIntoGroups ¶
SplitIntoGroups splits the slice into n groups and returns a 2D slice where each inner slice represents a group.
Panics with error of type *ers.ErrInvalidParameter if the number of groups is less than or equal to 0.
Parameters:
- slice: The slice to split.
- n: The number of groups to split the slice into.
Return:
- [][]T: A 2D slice where each inner slice represents a group.
Example:
slice := []int{1, 2, 3, 4, 5}
n := 3
groups := SplitIntoGroups(slice, n)
fmt.Println(groups) // Output: [[1 4] [2 5] [3]]
Types ¶
type ExitCode ¶ added in v0.2.20
type ExitCode int8
ExitCode is a custom type that represents the exit code of a program.
const ( // Success indicates that the program has finished successfully. Success ExitCode = iota // Panic indicates that a panic occurred during the execution of the program. Panic // SetupFailed indicates that the program could not be set up. SetupFailed // Error indicates that an error occurred during the execution of the program. Error )
Source Files