Documentation ¶
Overview ¶
Package emperror provides error handling solutions and tools to libraries and applications.
Index ¶
- Variables
- func Cause(err error) error
- func HandleIfErr(handler Handler, err error)
- func HandleRecover(handler Handler)
- func New(text string) error
- func NewWithStackTrace(text string) error
- func Recover(r interface{}) (err error)
- func With(err error, keyvals ...interface{}) error
- func WithMessage(err error, message string) error
- func WithPrefix(err error, keyvals ...interface{}) error
- func WithStack(err error) error
- type Causer
- type Contextor
- type ErrorCollection
- type Handler
- type HandlerFunc
- type HandlerLogFunc
- type MultiErrorBuilder
- type SingleWrapMode
- type StackTracer
- type TestHandler
Constants ¶
This section is empty.
Variables ¶
var ErrMissingValue = New("(MISSING)")
ErrMissingValue is appended to keyvals slices with odd length to substitute the missing value.
Functions ¶
func Cause ¶ added in v0.5.0
Cause returns the underlying cause of the error, if possible. An error value has a cause if it implements the Causer interface.
If the error does not implement Cause, the original error will be returned. If the error is nil, nil will be returned without further investigation.
This is an alias to github.com/pkg/errors.Cause function.
func HandleIfErr ¶ added in v0.1.1
HandleIfErr handles an error whenever it occures.
func HandleRecover ¶ added in v0.1.1
func HandleRecover(handler Handler)
HandleRecover recovers from a panic and handles the error.
defer emperror.HandleRecover(errorHandler)
func New ¶ added in v0.5.0
New returns an error that formats as the given text.
This is an alias to the stdlib errors.New function.
func NewWithStackTrace ¶ added in v0.5.0
NewWithStackTrace returns an error that formats as the given text and contains stack trace.
This is an alias to github.com/pkg/errors.New function.
func Recover ¶ added in v0.1.1
func Recover(r interface{}) (err error)
Recover accepts a recovered panic (if any) and converts it to an error (if necessary).
func With ¶ added in v0.5.0
With returns a new error with keyvals context appended to it. If the wrapped error is already a contextual error created by With or WithPrefix keyvals is appended to the existing context, but a new error is returned.
func WithMessage ¶ added in v0.5.0
WithMessage annotates err with a new message.
If err is nil, WithMessage returns nil.
This is an alias to github.com/pkg/errors.WithMessage function.
func WithPrefix ¶ added in v0.5.0
WithPrefix returns a new error with keyvals context appended to it. If the wrapped error is already a contextual error created by With or WithPrefix keyvals is prepended to the existing context, but a new error is returned.
Types ¶
type Causer ¶ added in v0.5.0
type Causer interface {
Cause() error
}
Causer is the interface defined in github.com/pkg/errors for specifying a parent error.
type Contextor ¶ added in v0.5.0
type Contextor interface {
Context() []interface{}
}
Contextor represents an error which holds a context.
type ErrorCollection ¶ added in v0.5.0
type ErrorCollection interface {
Errors() []error
}
ErrorCollection holds a list of errors.
type Handler ¶
type Handler interface { // Handle processes an error. Handle(err error) }
Handler is responsible for handling an error.
This interface allows libraries to decouple from logging and error handling solutions.
func NewCompositeHandler ¶
NewCompositeHandler returns a new compositeHandler.
func NewNopHandler ¶ added in v0.5.0
func NewNopHandler() Handler
NewNopHandler returns an error handler that doesn't do anything.
type HandlerFunc ¶ added in v0.5.0
type HandlerFunc func(err error)
HandlerFunc wraps a function and turns it into an error handler.
func (HandlerFunc) Handle ¶ added in v0.5.0
func (h HandlerFunc) Handle(err error)
Handle calls the underlying log function.
type HandlerLogFunc ¶ added in v0.5.0
type HandlerLogFunc func(args ...interface{})
HandlerLogFunc wraps a log-like function and turns it into an error handler.
func (HandlerLogFunc) Handle ¶ added in v0.5.0
func (h HandlerLogFunc) Handle(err error)
Handle calls the underlying log function.
type MultiErrorBuilder ¶ added in v0.5.0
type MultiErrorBuilder struct { Message string SingleWrapMode SingleWrapMode // contains filtered or unexported fields }
MultiErrorBuilder provides an interface for aggregating errors and exposing them as a single value.
func NewMultiErrorBuilder ¶ added in v0.5.0
func NewMultiErrorBuilder() *MultiErrorBuilder
NewMultiErrorBuilder returns a new MultiErrorBuilder.
func (*MultiErrorBuilder) Add ¶ added in v0.5.0
func (b *MultiErrorBuilder) Add(err error)
Add adds an error to the list.
Calling this method concurrently is not safe.
func (*MultiErrorBuilder) ErrOrNil ¶ added in v0.5.0
func (b *MultiErrorBuilder) ErrOrNil() error
ErrOrNil returns a MultiError the builder aggregates a list of errors, or returns nil if the list of errors is empty.
It is useful to avoid checking if there are any errors added to the list.
type SingleWrapMode ¶ added in v0.5.0
type SingleWrapMode int
SingleWrapMode defines how MultiErrorBuilder behaves when there is only one error in the list.
const ( AlwaysWrap SingleWrapMode = iota // Always return a MultiError. ReturnSingle // Return the single error. )
These constants cause MultiErrorBuilder to behave as described if there is only one error in the list.
type StackTracer ¶ added in v0.5.0
type StackTracer interface {
StackTrace() errors.StackTrace
}
StackTracer is the interface defined in github.com/pkg/errors for exposing stack trace from an error.
type TestHandler ¶
type TestHandler struct {
// contains filtered or unexported fields
}
TestHandler throws every error away.
func (*TestHandler) Errors ¶
func (h *TestHandler) Errors() []error
Errors returns all the handled errors.
func (*TestHandler) Handle ¶
func (h *TestHandler) Handle(err error)
Handle saves the error in a list.