Documentation
¶
Overview ¶
Package errors is a github.com/pkg/errors compatible API for native errors.
Copied over from github.com/crossplane/crossplane-runtime/pkg/errors for better discoverability and possibly diverge in the future.
Index ¶
- func As(err error, target any) bool
- func Cause(err error) error
- func Errorf(format string, a ...any) error
- func Is(err, target error) bool
- func New(text string) error
- func Unwrap(err error) error
- func WithMessage(err error, message string) error
- func WithMessagef(err error, format string, args ...any) error
- func Wrap(err error, message string) error
- func Wrapf(err error, format string, args ...any) error
- type MultiError
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. Otherwise, it returns false.
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(any) bool such that As(target) returns true. In the latter case, the As method is responsible for setting target.
An error type might provide an As method so it can be treated as if it were a different error type.
As panics if target is not a non-nil pointer to either a type that implements error, or to any interface type.
func Cause ¶
Cause calls Unwrap on each error it finds. It returns the first error it finds that does not have an Unwrap method - i.e. the first error that was not the result of a Wrap call, a Wrapf call, or an Errorf call with %w wrapping.
func Errorf ¶
Errorf formats according to a format specifier and returns the string as a value that satisfies error.
If the format specifier includes a %w verb with an error operand, the returned error will implement an Unwrap method returning the operand. It is invalid to include more than one %w verb or to supply it with an operand that does not implement the error interface. The %w verb is otherwise a synonym for %v.
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.
An error type might provide an Is method so it can be treated as equivalent to an existing error. For example, if MyError defines
func (m MyError) Is(target error) bool { return target == fs.ErrExist }
then Is(MyError{}, fs.ErrExist) returns true. See syscall.Errno.Is for an example in the standard library.
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 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 WithMessage ¶
WithMessage annotates err with a new message. If err is nil, WithMessage returns nil.
func WithMessagef ¶
WithMessagef annotates err with the format specifier. If err is nil, WithMessagef returns nil.
Types ¶
type MultiError ¶
MultiError is an error that wraps multiple errors.
func Join ¶
func Join(errs ...error) MultiError
Join returns an error that wraps the given errors. Any nil error values are discarded. Join returns nil if errs contains no non-nil values. The error formats as the concatenation of the strings obtained by calling the Error method of each element of errs and formatting like:
[first error, second error, third error]
Note: aggregating errors should not be the default. Usually, return only the first error, and only aggregate if there is clear value to the user.
Source Files