Documentation ¶
Overview ¶
Package errors provides a custom error type for out-of-bound errors.
Package errors provides a custom error type for out-of-bound errors.
Index ¶
- Constants
- func As[T any](err error) bool
- func IsErrIgnorable(err error) bool
- func IsNoError(err error) bool
- func LimitErrorMsg(err error, limit int) error
- type ErrAfter
- type ErrAt
- type ErrBefore
- type ErrEmptySlice
- type ErrEmptyString
- type ErrGT
- type ErrGTE
- type ErrIgnorable
- type ErrInvalidCall
- type ErrInvalidCharacter
- type ErrInvalidParameter
- type ErrInvalidRune
- type ErrInvalidType
- type ErrInvalidUsage
- type ErrInvalidValue
- type ErrLT
- type ErrLTE
- type ErrNilValue
- type ErrNoError
- type ErrNotComparable
- type ErrOutOfBounds
- type ErrPanic
- type ErrUnexpected
- type ErrUnexpectedError
- type Unwrapper
Constants ¶
const ( // DefaultLFPermissions is the default file permissions for creating a log file. DefaultLFPermissions fs.FileMode = 0666 // DefaultLFExtension is the default file extension for creating a log file. DefaultLFExtension string = ".log.md" // DefaultLFFlags is the default flags for creating a log file. DefaultLFFlags int = os.O_CREATE | os.O_WRONLY | os.O_APPEND // DefaultLoggerFlags is the default flags for creating a logger. DefaultLoggerFlags int = log.LstdFlags | log.Llongfile )
Variables ¶
This section is empty.
Functions ¶
func As ¶ added in v0.2.32
As is function that checks if an error is of type T.
If the error is nil, the function returns false.
Parameters:
- err: The error to check.
Returns:
- bool: true if the error is of type T, false otherwise.
func IsErrIgnorable ¶
IsErrIgnorable checks if an error is an *ErrIgnorable or *ErrInvalidParameter error. If the error is nil, the function returns false.
Parameters:
- err: The error to check.
Returns:
- bool: True if the error is an *ErrIgnorable or *ErrInvalidParameter error, otherwise false.
func IsNoError ¶
IsNoError checks if an error is a no error error or if it is nil.
Parameters:
- err: The error to check.
Returns:
- bool: True if the error is a no error error or if it is nil, otherwise false.
func LimitErrorMsg ¶ added in v0.2.34
LimitErrorMsg limits the error message to a certain number of unwraps. It returns the top level error for allowing to print the error message with the limit of unwraps applied.
If the error is nil or the limit is less than 0, the function does nothing.
Parameters:
- err: The error to limit.
- limit: The limit of unwraps.
Returns:
- error: The top level error with the limit of unwraps applied.
Types ¶
type ErrAfter ¶ added in v0.2.34
type ErrAfter struct { // After is the element that was processed before the error occurred. After string // Reason is the reason for the error. Reason error }
ErrAfter is an error that is returned when something goes wrong after a certain element in a stream of data.
func NewErrAfter ¶ added in v0.2.34
NewErrAfter creates a new ErrAfter error.
Parameters:
- after: The element that was processed before the error occurred.
- reason: The reason for the error.
Returns:
- *ErrAfter: A pointer to the new ErrAfter error.
func (*ErrAfter) ChangeReason ¶ added in v0.2.34
ChangeReason changes the reason for the error.
Parameters:
- reason: The new reason for the error.
type ErrAt ¶ added in v0.2.33
type ErrAt struct { // Index is the index where the error occurred. Index int // Reason is the reason for the error. Reason error }
ErrAt represents an error that occurs at a specific index.
func NewErrAt ¶ added in v0.2.33
NewErrAt creates a new ErrAt error.
Parameters:
- index: The index where the error occurred.
- reason: The reason for the error.
Returns:
- *ErrAt: A pointer to the newly created ErrAt.
func (*ErrAt) ChangeReason ¶ added in v0.2.34
ChangeReason changes the reason for the error.
Parameters:
- reason: The new reason for the error.
type ErrBefore ¶ added in v0.2.34
type ErrBefore struct { // Before is the element that was processed before the error occurred. Before string // Reason is the reason for the error. Reason error }
ErrBefore is an error that is returned when something goes wrong before a certain element in a stream of data.
func NewErrBefore ¶ added in v0.2.34
NewErrBefore creates a new ErrBefore error.
Parameters:
- before: The element that was processed before the error occurred.
- reason: The reason for the error.
Returns:
- *ErrBefore: A pointer to the new ErrBefore error.
func (*ErrBefore) ChangeReason ¶ added in v0.2.34
ChangeReason changes the reason for the error.
Parameters:
- reason: The new reason for the error.
type ErrEmptySlice ¶ added in v0.2.33
type ErrEmptySlice struct{}
ErrEmptySlice represents an error when a slice is empty.
func NewErrEmptySlice ¶ added in v0.2.33
func NewErrEmptySlice() *ErrEmptySlice
NewErrEmptySlice creates a new ErrEmptySlice error.
Returns:
- *ErrEmptySlice: A pointer to the newly created ErrEmptySlice.
func (*ErrEmptySlice) Error ¶ added in v0.2.33
func (e *ErrEmptySlice) Error() string
Error is a method of the error interface that returns the error message.
Returns:
- string: The error message.
type ErrEmptyString ¶ added in v0.2.32
type ErrEmptyString struct{}
ErrEmptyString represents an error when a string is empty.
func NewErrEmptyString ¶ added in v0.2.32
func NewErrEmptyString() *ErrEmptyString
NewErrEmptyString creates a new ErrEmptyString error.
Returns:
- *ErrEmptyString: A pointer to the newly created ErrEmptyString.
func (*ErrEmptyString) Error ¶ added in v0.2.32
func (e *ErrEmptyString) Error() string
Error is a method of the error interface that returns the error message.
Returns:
- string: The error message.
type ErrGT ¶ added in v0.2.32
type ErrGT struct { // Value is the value that caused the error. Value int }
ErrGT represents an error when a value is less than or equal to a specified value.
type ErrGTE ¶ added in v0.2.32
type ErrGTE struct { // Value is the value that caused the error. Value int }
ErrGTE represents an error when a value is less than a specified value.
type ErrIgnorable ¶
type ErrIgnorable struct { // Err is the error that can be ignored. Err error }
ErrIgnorable represents an error that can be ignored. Useful for indicating that an error is ignorable.
func NewErrIgnorable ¶
func NewErrIgnorable(err error) *ErrIgnorable
NewErrIgnorable creates a new ErrIgnorable error.
Parameters:
- err: The error that can be ignored.
Returns:
- *ErrIgnorable: A pointer to the newly created ErrIgnorable.
func (*ErrIgnorable) ChangeReason ¶ added in v0.2.34
func (e *ErrIgnorable) ChangeReason(reason error)
ChangeReason changes the reason for the ignorable error.
Parameters:
- reason: The new reason for the ignorable error.
func (*ErrIgnorable) Error ¶
func (e *ErrIgnorable) Error() string
Error is a method of the error interface. It does not mention that the error is ignorable.
Returns:
- string: The error message of the ignorable error (no mention of being ignorable).
func (*ErrIgnorable) Unwrap ¶
func (e *ErrIgnorable) Unwrap() error
Unwrap returns the error that can be ignored. It is used for error unwrapping.
Returns:
- error: The error that can be ignored.
type ErrInvalidCall ¶
type ErrInvalidCall struct { // FnName is the name of the function. FnName string // Signature is the Signature of the function. Signature reflect.Type // Reason is the Reason for the failure. Reason error }
ErrInvalidCall represents an error that occurs when a function is not called correctly.
func NewErrInvalidCall ¶
func NewErrInvalidCall(functionName string, function any, reason error) *ErrInvalidCall
NewErrInvalidCall creates a new ErrInvalidCall. If the reason is not provided (nil), the reason is set to "an error occurred while calling the function" by default.
Parameters:
- functionName: The name of the function.
- function: The function that failed.
- reason: The reason for the failure.
Returns:
- *ErrInvalidCall: A pointer to the new ErrInvalidCall.
func (*ErrInvalidCall) ChangeReason ¶ added in v0.2.34
func (e *ErrInvalidCall) ChangeReason(reason error)
ChangeReason changes the reason for the failure of the function call.
Parameters:
- reason: The new reason for the failure.
func (*ErrInvalidCall) Error ¶
func (e *ErrInvalidCall) Error() string
Error is a method of the error interface.
Returns:
- string: The error message.
func (*ErrInvalidCall) Unwrap ¶
func (e *ErrInvalidCall) Unwrap() error
Unwrap returns the underlying error that caused the ErrInvalidCall. It is used for error unwrapping.
Returns:
- error: The reason for the failure.
type ErrInvalidCharacter ¶ added in v0.2.39
type ErrInvalidCharacter struct {
Character rune
}
ErrInvalidCharacter represents an error when an invalid character is found.
func NewErrInvalidCharacter ¶ added in v0.2.39
func NewErrInvalidCharacter(character rune) *ErrInvalidCharacter
NewErrInvalidCharacter creates a new ErrInvalidCharacter error.
Parameters:
- character: The invalid character.
Returns:
- *ErrInvalidCharacter: The new ErrInvalidCharacter error.
func (*ErrInvalidCharacter) Error ¶ added in v0.2.39
func (e *ErrInvalidCharacter) Error() string
Error returns the error message: "invalid character (character)".
Returns:
- string: The error message.
type ErrInvalidParameter ¶
type ErrInvalidParameter struct { // Parameter is the name of the Parameter. Parameter string // Reason is the Reason for the invalidity of the parameter. Reason error }
ErrInvalidParameter represents an error when a parameter is invalid.
func NewErrInvalidParameter ¶
func NewErrInvalidParameter(parameter string, reason error) *ErrInvalidParameter
NewErrInvalidParameter creates a new ErrInvalidParameter error. If the reason is not provided (nil), the reason is set to "parameter is invalid" by default.
Parameters:
- parameter: The name of the parameter.
- reason: The reason for the invalidity.
Returns:
- error: A pointer to the newly created ErrInvalidParameter.
func NewErrNilParameter ¶
func NewErrNilParameter(parameter string) *ErrInvalidParameter
ErrNilParameter represents an error when a parameter is nil. This is a shorthand for NewErrInvalidParameter(parameter, NewErrNilValue()).
Parameters:
- parameter: The name of the parameter.
Returns:
- *ErrInvalidParameter: A pointer to the newly created ErrInvalidParameter.
func (*ErrInvalidParameter) ChangeReason ¶ added in v0.2.34
func (e *ErrInvalidParameter) ChangeReason(reason error)
ChangeReason changes the reason for the invalidity of the parameter.
Parameters:
- reason: The new reason for the invalidity of the parameter.
func (*ErrInvalidParameter) Error ¶
func (e *ErrInvalidParameter) Error() string
Error is a method of the error interface.
If the reason is not provided (nil), no reason is included in the error message.
Returns:
- string: The error message.
func (*ErrInvalidParameter) Unwrap ¶
func (e *ErrInvalidParameter) Unwrap() error
Unwrap returns the reason for the invalidity of the parameter. It is used for error unwrapping.
Returns:
- error: The reason for the invalidity of the parameter.
type ErrInvalidRune ¶ added in v0.2.33
type ErrInvalidRune struct { // Reason is the reason for the invalidity of the rune. Reason error }
ErrInvalidRune represents an error when an invalid rune is encountered.
func NewErrInvalidRune ¶ added in v0.2.33
func NewErrInvalidRune(reason error) *ErrInvalidRune
NewErrInvalidRune creates a new ErrInvalidRuneAt error.
Parameters:
- reason: The reason for the invalidity of the rune.
Returns:
- *ErrInvalidRune: A pointer to the newly created ErrInvalidRune.
func (*ErrInvalidRune) ChangeReason ¶ added in v0.2.34
func (e *ErrInvalidRune) ChangeReason(reason error)
ChangeReason changes the reason for the invalidity of the rune.
Parameters:
- reason: The new reason for the invalidity of the rune.
func (*ErrInvalidRune) Error ¶ added in v0.2.33
func (e *ErrInvalidRune) Error() string
Error is a method of the error interface that returns the error message.
If the reason is not provided (nil), no reason is included in the error message.
Returns:
- string: The error message.
func (*ErrInvalidRune) Unwrap ¶ added in v0.2.33
func (e *ErrInvalidRune) Unwrap() error
Unwrap returns the reason for the invalidity of the rune. It is used for error unwrapping.
Returns:
- error: The reason for the invalidity of the rune.
type ErrInvalidType ¶ added in v0.2.38
type ErrInvalidType[T any] struct { // Elem is the element that caused the error. Elem T // Type is the name of the type that was expected. Type string }
ErrInvalidType represents an error when a value has an invalid type.
func NewErrInvalidType ¶ added in v0.2.38
func NewErrInvalidType[T any](typeName string, elem T) *ErrInvalidType[T]
NewErrInvalidType creates a new ErrInvalidType error.
Parameters:
- typeName: The name of the type that was expected.
- elem: The element that caused the error.
Returns:
- *ErrInvalidType: A pointer to the newly created ErrInvalidType.
func (*ErrInvalidType[T]) Error ¶ added in v0.2.38
func (e *ErrInvalidType[T]) Error() string
Error is a method of the error interface that returns the error message.
Returns:
- string: The error message.
type ErrInvalidUsage ¶ added in v0.2.34
type ErrInvalidUsage struct { // Reason is the reason for the invalid usage. Reason error // Usage is the usage of the function. Usage string }
ErrInvalidUsage represents an error that occurs when a function is used incorrectly.
func NewErrInvalidUsage ¶ added in v0.2.34
func NewErrInvalidUsage(reason error, usage string) *ErrInvalidUsage
NewErrInvalidUsage creates a new ErrInvalidUsage error.
Parameters:
- reason: The reason for the invalid usage.
- usage: The usage of the function.
Returns:
- *ErrInvalidUsage: A pointer to the new ErrInvalidUsage error.
func (*ErrInvalidUsage) ChangeReason ¶ added in v0.2.34
func (e *ErrInvalidUsage) ChangeReason(reason error)
ChangeReason changes the reason for the invalid usage.
Parameters:
- reason: The new reason for the invalid usage.
func (*ErrInvalidUsage) Error ¶ added in v0.2.34
func (e *ErrInvalidUsage) Error() string
Error is a method of the error interface.
Returns:
- string: The error message.
func (*ErrInvalidUsage) Unwrap ¶ added in v0.2.34
func (e *ErrInvalidUsage) Unwrap() error
Unwrap returns the reason for the invalid usage. It is used for error unwrapping.
Returns:
- error: The reason for the invalid usage.
type ErrInvalidValue ¶ added in v0.2.32
type ErrInvalidValue struct { // Values is the list of invalid values. Values []int }
ErrInvalidValue represents an error when a value is invalid.
func NewErrInvalidValue ¶ added in v0.2.32
func NewErrInvalidValue(values ...int) *ErrInvalidValue
NewErrInvalidValue creates a new ErrInvalidValue error.
Parameters:
- values: The list of invalid values.
Returns:
- *ErrInvalidValue: A pointer to the newly created ErrInvalidValue.
func (*ErrInvalidValue) Error ¶ added in v0.2.32
func (e *ErrInvalidValue) Error() string
Error is a method of the error interface that returns the error message.
Returns:
- string: The error message.
type ErrLT ¶ added in v0.2.32
type ErrLT struct { // Value is the value that caused the error. Value int }
ErrLT represents an error when a value is greater than or equal to a specified value.
type ErrLTE ¶ added in v0.2.32
type ErrLTE struct { // Value is the value that caused the error. Value int }
ErrLTE represents an error when a value is greater than a specified value.
type ErrNilValue ¶ added in v0.2.39
type ErrNilValue struct{}
ErrNilValue represents an error when a value is nil.
func NewErrNilValue ¶ added in v0.2.39
func NewErrNilValue() *ErrNilValue
NewErrNilValue creates a new ErrNilValue error.
Returns:
- *ErrNilValue: The new ErrNilValue error.
func (*ErrNilValue) Error ¶ added in v0.2.39
func (e *ErrNilValue) Error() string
Error returns the error message: "value must not be nil".
Returns:
- string: The error message.
type ErrNoError ¶
type ErrNoError struct { // Err is the reason for the no error error. Err error }
ErrNoError represents an error when no error occurs.
func NewErrNoError ¶
func NewErrNoError(err error) *ErrNoError
NewErrNoError creates a new ErrNoError error.
Parameters:
- err: The reason for the no error error.
Returns:
- *ErrNoError: A pointer to the newly created ErrNoError.
func (*ErrNoError) ChangeReason ¶ added in v0.2.34
func (e *ErrNoError) ChangeReason(reason error)
ChangeReason changes the reason of the no error error.
Parameters:
- reason: The new reason for the no error error.
func (*ErrNoError) Error ¶
func (e *ErrNoError) Error() string
Error is a method of the error interface.
Returns:
- string: The error message of the no error error (no mention of being a no error error).
func (*ErrNoError) Unwrap ¶
func (e *ErrNoError) Unwrap() error
Unwrap is a method of the errors interface.
Returns:
- error: The reason for the no error error.
type ErrNotComparable ¶ added in v0.2.39
type ErrNotComparable struct{}
ErrNotComparable represents an error when a value is not comparable.
func NewErrNotComparable ¶ added in v0.2.39
func NewErrNotComparable() *ErrNotComparable
NewErrNotComparable creates a new ErrNotComparable error.
Returns:
- *ErrNotComparable: The new ErrNotComparable error.
func (*ErrNotComparable) Error ¶ added in v0.2.39
func (e *ErrNotComparable) Error() string
Error returns the error message: "value is not comparable".
Returns:
- string: The error message.
type ErrOutOfBounds ¶
type ErrOutOfBounds struct {
// LowerBound and UpperBound are the lower and upper bounds of the range,
// respectively.
LowerBound, UpperBound int
// LowerInclusive and UpperInclusive are flags indicating whether the lower
// and upper bounds are inclusive, respectively.
LowerInclusive, UpperInclusive bool
// Value is the value that caused the error.
Value int
}
ErrOutOfBounds represents an error when a value is out of a specified range.
func NewErrOutOfBounds ¶
func NewErrOutOfBounds(value int, lowerBound, upperBound int) *ErrOutOfBounds
NewOutOfBounds creates a new ErrOutOfBound error. If no inclusivity flags are provided, the lower bound is inclusive and the upper bound is exclusive.
Parameters:
- lowerBound, upperbound: The lower and upper bounds of the range, respectively.
- value: The value that caused the error.
Returns:
- *ErrOutOfBounds: A pointer to the newly created ErrOutOfBound.
func (*ErrOutOfBounds) Error ¶
func (e *ErrOutOfBounds) Error() string
Error is a method of the error interface.
The format of the error message is as follows:
value (value) not in range [lowerBound, upperBound]
The square brackets indicate that the lower bound is inclusive, while the parentheses indicate that the upper bound is exclusive.
Returns:
- string: The error message of the out-of-bound error.
func (*ErrOutOfBounds) WithLowerBound ¶
func (e *ErrOutOfBounds) WithLowerBound(isInclusive bool) *ErrOutOfBounds
WithLowerBound sets the inclusivity of the lower bound.
Parameters:
- isInclusive: A boolean indicating whether the lower bound is inclusive.
Returns:
- *ErrOutOfBound: The error instance for chaining.
func (*ErrOutOfBounds) WithUpperBound ¶
func (e *ErrOutOfBounds) WithUpperBound(isInclusive bool) *ErrOutOfBounds
WithUpperBound sets the inclusivity of the upper bound.
Parameters:
- isInclusive: A boolean indicating whether the upper bound is inclusive.
Returns:
- *ErrOutOfBound: The error instance for chaining.
type ErrPanic ¶
type ErrPanic struct { // Value is the value that caused the panic. Value any }
ErrPanic represents an error when a panic occurs.
func NewErrPanic ¶
NewErrPanic creates a new ErrPanic error.
Parameters:
- value: The value that caused the panic.
Returns:
- *ErrPanic: A pointer to the newly created ErrPanic.
type ErrUnexpected ¶
type ErrUnexpected struct { // Expected is the list of expected values. Expected []string // Actual is the actual value encountered. Actual fmt.Stringer }
ErrUnexpected represents an error that occurs when an unexpected value is encountered.
func NewErrUnexpected ¶
func NewErrUnexpected(got fmt.Stringer, expected ...string) *ErrUnexpected
NewErrUnexpected creates a new ErrUnexpected error.
Parameters:
- got: The actual value encountered.
- expected: The list of expected values.
Returns:
- *ErrUnexpected: A pointer to the newly created ErrUnexpected.
func (*ErrUnexpected) Error ¶
func (e *ErrUnexpected) Error() string
Error is a method of the error interface.
Returns:
- string: The error message.
type ErrUnexpectedError ¶ added in v0.2.34
type ErrUnexpectedError struct { // Reason is the reason for the unexpected error. Reason error }
func NewErrUnexpectedError ¶ added in v0.2.34
func NewErrUnexpectedError(reason error) *ErrUnexpectedError
NewErrUnexpectedError creates a new ErrUnexpectedError error.
Parameters:
- reason: The reason for the unexpected error.
Returns:
- *ErrUnexpectedError: A pointer to the new ErrUnexpectedError error.
func (*ErrUnexpectedError) ChangeReason ¶ added in v0.2.34
func (e *ErrUnexpectedError) ChangeReason(reason error)
ChangeReason changes the reason for the unexpected error.
Parameters:
- reason: The new reason for the unexpected error.
func (*ErrUnexpectedError) Error ¶ added in v0.2.34
func (e *ErrUnexpectedError) Error() string
Error is a method of the error interface.
Returns:
- string: The error message.
func (*ErrUnexpectedError) Unwrap ¶ added in v0.2.34
func (e *ErrUnexpectedError) Unwrap() error
Unwrap returns the reason for the unexpected error. It is used for error unwrapping.
Returns:
- error: The reason for the unexpected error.
type Unwrapper ¶ added in v0.2.34
type Unwrapper interface { // Unwrap returns the error that this error wraps. // // Returns: // - error: The error that this error wraps. Unwrap() error // ChangeReason changes the reason of the error. // // Parameters: // - reason: The new reason of the error. ChangeReason(reason error) }
Unwrapper is an interface that defines a method to unwrap an error.