README
¶
errors
Stdlib errors package extension. go1.13 errors.Is and errors.As are the same functions as in stdlib (not even copies).
// as usual
err = errors.New("msg")
// fmt.Sprintf like
err = errors.New("message %v", "args")
// add Frame info
err = errors.NewHere("msg")
// one Frame higher
err = errors.NewDepth(1, "msg")
// the same result as previous
f := errors.Caller(1)
err = errors.NewFrame(f, "msg")
// Wrap error
err = errors.Wrap(err, "msg %v", "args")
// all the same function types are available
err = errors.WrapHere(err, "msg %v", "args")
err = errors.WrapDepth(err, 1, "msg %v", "args")
err = errors.WrapFrame(err, f, "msg %v", "args")
Caller
Caller frame can be added to error so later you can get to know where error was generated.
f := errors.Caller(1)
f = errors.Funcentry(1)
Documentation
¶
Index ¶
- func As(err error, target interface{}) bool
- func Is(err, target error) bool
- func New(f string, args ...interface{}) error
- func NewDepth(d int, f string, args ...interface{}) error
- func NewFrame(frame Frame, f string, args ...interface{}) error
- func NewHere(f string, args ...interface{}) error
- func Unwrap(err error) error
- func Wrap(err error, f string, args ...interface{}) error
- func WrapDepth(err error, d int, f string, args ...interface{}) error
- func WrapFrame(err error, frame Frame, f string, args ...interface{}) error
- func WrapHere(err error, f string, args ...interface{}) error
- type Frame
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func As ¶
As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true.
The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.
An error matches target if the error's concrete value is assignable to the value pointed to by target, or if the error has a method As(interface{}) bool such that As(target) returns true. In the latter case, the As method is responsible for setting target.
As will panic if target is not a non-nil pointer to either a type that implements error, or to any interface type. As returns false if err is nil.
link to stdlib errors.As
func Is ¶
Is reports whether any error in err's chain matches target.
The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.
An error is considered to match a target if it is equal to that target or if it implements a method Is(error) bool such that Is(target) returns true.
link to stdlib errors.Is
func New ¶
New returns an error that formats as the given text. Each call to New returns a distinct error value even if the text is identical.
func NewDepth ¶
NewDepth returns an error that formats as the given text. Frame where error was created (d frames higher) is recorded. Each call to New returns a distinct error value even if the text is identical.
func NewFrame ¶ added in v0.2.0
NewFrame returns an error with given Frame that formats as the given text. Each call to New returns a distinct error value even if the text is identical.
func NewHere ¶
NewHere returns an error that formats as the given text. Frame where error was created is recorded. Each call to New returns a distinct error value even if the text is identical.
func Unwrap ¶
Unwrap returns the result of calling the Unwrap method on err, if err's type contains an Unwrap method returning error. Otherwise, Unwrap returns nil.
func Wrap ¶
Wrap returns an error that describes given error with given text. Returns nil if err is nil.
func WrapDepth ¶
WrapDepth returns an error that describes given error with given text. Frame where error was created (d frames higher) is recorded. Returns nil if err is nil.
Source Files