errorsutil

Documentation

Index

• func ErrIndexOutOfRange(idx, len int) error
• func ErrorsToStrings(errs []error) (int, []string)
• func Join(inclNils bool, errs ...error) error
• func NewErrorWithLocation(msg string) error
• func NilifyIs(err error, errs ...error) error
• func PanicOnErr(err error)
• func Wrap(err error, wrap ...string) error
• func Wrapf(origErr error, wrapFormat string, wrapVars ...any) error
• type ErrorInfo
• type ErrorInfos
  • func (eis ErrorInfos) ErrorsString() []string
  • func (eis ErrorInfos) Filter(isError bool) ErrorInfos
  • func (eis ErrorInfos) GoodCorrects() []string
  • func (eis ErrorInfos) GoodInputs() []string
  • func (eis ErrorInfos) Inflate()
• type ErrorWithLocation
  • func (e *ErrorWithLocation) Error() string

Functions

func ErrIndexOutOfRange

func ErrIndexOutOfRange(idx, len int) error

ErrIndexOutOfRange returns an `error` using the standard message for index out of range.

func ErrorsToStrings

func ErrorsToStrings(errs []error) (int, []string)

ErrorsToStrings returns a slice of strings. A count of non-nil errors is also returned.

func Join

func Join(inclNils bool, errs ...error) error

func NewErrorWithLocation

func NewErrorWithLocation(msg string) error

func NilifyIs

func NilifyIs(err error, errs ...error) error

NilifyIs will return a `nil` for if the supplied `err` `errors.Is() any of the errors in `errs`.`

func PanicOnErr

func PanicOnErr(err error)

PanicOnErr is a syntactic sugar function to panic on error.

func Wrap

func Wrap(err error, wrap ...string) error

Wrap wraps an error with the supplied strings.

func Wrapf

func Wrapf(origErr error, wrapFormat string, wrapVars ...any) error

Wrapf will wrap the error, first performing a `fmt.Sprintf()` on the supplied params.

Types

type ErrorInfo

type ErrorInfo struct {
	Error       error
	ErrorString string // must match Error
	Code        string
	Summary     string
	Description string
	Explanation string
	Source      string
	Input       string
	Correct     string
}

type ErrorInfos

type ErrorInfos []*ErrorInfo

func (ErrorInfos) ErrorsString

func (eis ErrorInfos) ErrorsString() []string

func (ErrorInfos) Filter

func (eis ErrorInfos) Filter(isError bool) ErrorInfos

func (ErrorInfos) GoodCorrects

func (eis ErrorInfos) GoodCorrects() []string

func (ErrorInfos) GoodInputs

func (eis ErrorInfos) GoodInputs() []string

func (ErrorInfos) Inflate

func (eis ErrorInfos) Inflate()

type ErrorWithLocation

type ErrorWithLocation struct {
	Msg  string
	File string
	Line int
}

ErrorWithLocation represents an error message with code file and line locaiton. It is automatically populated when instantiated with `NewErrorWithLocation()`, and follows the `errors.Error` interface.

func (*ErrorWithLocation) Error

func (e *ErrorWithLocation) Error() string