Documentation
¶
Overview ¶
Package errors provides errors stack tracking utilities.
Index ¶
- func As(err error, target interface{}) bool
- func CallDetail(msg []byte, fn interface{}, args ...interface{}) []byte
- func Detail(err error) stringdeprecated
- func Err(err error) error
- func Is(err, target error) bool
- func IsNotFound(err error) bool
- func New(msg string) error
- func Summary(err error) string
- func Unwrap(err error) error
- type ErrorInfodeprecated
- type Frame
- type List
- type NotFound
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func As ¶ added in v1.10.4
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(interface{}) 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 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 CallDetail ¶ added in v1.10.9
CallDetail print a function call shortly.
func Is ¶ added in v1.10.4
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 == os.ErrExist }
then Is(MyError{}, os.ErrExist) returns true. See syscall.Errno.Is for an example in the standard library.
func IsNotFound ¶ added in v1.11.8
IsNotFound unwraps err and checks it is a *NotFound object or not.
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.
Types ¶
type ErrorInfo
deprecated
type ErrorInfo = Frame
ErrorInfo is provided for backward compatibility
Deprecated: Use Frame instead.
func (*ErrorInfo) AppendErrorDetail ¶
AppendErrorDetail is provided for backward compatibility
func (*ErrorInfo) ErrorDetail ¶
ErrorDetail is provided for backward compatibility
func (*ErrorInfo) NestedObject ¶
func (p *ErrorInfo) NestedObject() interface{}
NestedObject is provided for backward compatibility
func (*ErrorInfo) SummaryErr ¶
SummaryErr is provided for backward compatibility
type Frame ¶ added in v1.10.4
Frame represents an error frame.
type List ¶ added in v1.11.8
type List []error
List represents a list of errors.
Source Files