Documentation ¶
Overview ¶
Package errors defines the generic error codes, nestable ExtErr object.
Index ¶
- Constants
- func As(err error, target interface{}) bool
- func AttachTo(container *withCauses, errs ...error)
- func CanAs(err interface{}) (ok bool)
- func CanAttach(err interface{}) bool
- func CanCause(err interface{}) bool
- func CanIs(err interface{}) (ok bool)
- func CanUnwrap(err interface{}) (ok bool)
- func Cause(err error) error
- func Cause1(err error) error
- func ContainerIsEmpty(container error) bool
- func DumpStacksAsString(allRoutines bool) string
- func Is(err, target error) bool
- func New(message string, args ...interface{}) error
- func NewContainer(message string, args ...interface{}) *withCauses
- func Unwrap(err error) error
- func WithCause(cause error, msg string) error
- func WithStack(cause error) error
- func Wrap(err error, message string, args ...interface{}) error
- type Frame
- type StackTrace
Constants ¶
const ( // AppName const AppName = "errors" // Version const Version = "2.0.1" // VersionInt const VersionInt = 0x020001 )
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.
func AttachTo ¶
func AttachTo(container *withCauses, errs ...error)
AttachTo appends more errors into 'container' error container.
func Cause ¶
Cause returns the underlying cause of the error recursively, if possible. An error value has a cause if it implements the following interface:
type causer interface { Cause() error }
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.
func Cause1 ¶
Cause1 returns the underlying cause of the error, if possible. An error value has a cause if it implements the following interface:
type causer interface { Cause() error }
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.
func ContainerIsEmpty ¶
ContainerIsEmpty appends more errors into 'container' error container.
func DumpStacksAsString ¶
DumpStacksAsString returns stack tracing information like debug.PrintStack()
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.
func NewContainer ¶
func NewContainer(message string, args ...interface{}) *withCauses
NewContainer wraps a group of errors and msg as one and return it. The returned error object is a container to hold many sub-errors.
Examples:
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.
Types ¶
type Frame ¶
type Frame uintptr
Frame represents a program counter inside a stack frame.
func (Frame) Format ¶
Format formats the frame according to the fmt.Formatter interface.
%s source file %d source line %n function name %v equivalent to %s:%d
Format accepts flags that alter the printing of some verbs, as follows:
%+s function name and path of source file relative to the compile time GOPATH separated by \n\t (<funcname>\n\t<path>) %+v equivalent to %+s:%d
type StackTrace ¶
type StackTrace []Frame
StackTrace is stack of Frames from innermost (newest) to outermost (oldest).
func (StackTrace) Format ¶
func (st StackTrace) Format(s fmt.State, verb rune)
Format formats the stack of Frames according to the fmt.Formatter interface.
%s lists source files for each Frame in the stack %v lists the source file and line number for each Frame in the stack
Format accepts flags that alter the printing of some verbs, as follows:
%+v Prints filename, function, and line number for each Frame in the stack.