# README
zerrors
NOTICE: This is work in progress. Do not use!
Installation
go get -u github.com/dtomasi/zerrors
Usage example
TBD
# Functions
As see: https://pkg.go.dev/golang.org/x/xerrors#As.
Caller see: https://pkg.go.dev/golang.org/x/xerrors#Caller.
Errorf see: https://pkg.go.dev/golang.org/x/xerrors#Errorf.
FormatError see: https://pkg.go.dev/golang.org/x/xerrors#FormatError.
Is see: https://pkg.go.dev/golang.org/x/xerrors#Is.
IsType Check if a given error is matching given type Example: zerrors.IsType(err, MyErrorTypeWithStringerInterface).
Mask simply masks an error with no message.
New creates a new error with message.
Newf creates a new error with formatted message.
NewWithOpts creates a new error with optional passed options see: ./options.go for available options.
Opaque see: https://pkg.go.dev/golang.org/x/xerrors#Opaque.
Unwrap see: https://pkg.go.dev/golang.org/x/xerrors#Unwrap.
WalkErrChain provides a simple way to walk e error chain using Unwrap function.
WithContext allows passing a context to the error.
WithContextValue allows passing a key/value pair to the error, which is stored inside the context.Context NOTE: If no context is defined while this option is applied, it will create an empty context using context.TODO().
WithSkipCallers allows defining how many caller frames should be skipped.
WithType allows to pass a type (fmt.Stringer compatible) to the error.
WithWrappedError allows to pass an error that should be wrapped.
Wrap wraps a given error with a new zError instance.
Wrapf wraps a given error with a new zError instance and allows format message string.
WrapPtr wraps a given error pointer with a new zError instance This is useful for defer used with named return types.
WrapPtrf wraps a given error pointer with a new zError instance and allows format message string This is useful for defer used with named return types.
WrapPtrWithOpts wraps an error pointer.
WrapWithOpts wraps an error.
# Constants
GenericError is the default error type.
# Variables
nolint:gochecknoglobals.
# Interfaces
ContextAwareError defines an error that contains an context.
TypeAwareError defines an error that is aware of its type.
# Type aliases
ErrorOpt defines the option function.
ErrorType defines an easy to use fmt.Stringer compatible error type.
Formatter see: https://pkg.go.dev/golang.org/x/xerrors#Formatter.
Frame see: https://pkg.go.dev/golang.org/x/xerrors#Frame.
Printer see: https://pkg.go.dev/golang.org/x/xerrors#Printer.
Wrapper see: https://pkg.go.dev/golang.org/x/xerrors#Wrapper.