errors

Documentation

Index

• func As(err error, target interface{}) bool
• func Cause(err error) error
• func Errorf(format string, args ...interface{}) error
• func Is(err, target error) bool
• func IsCode(err error, code int) bool
• func MustRegister(coder Coder)
• func New(message string) error
• func Register(coder Coder)
• func Unwrap(err error) error
• func WithCode(code int, format string, args ...interface{}) error
• func WithMessage(err error, message string) error
• func WithMessagef(err error, format string, args ...interface{}) error
• func WithStack(err error) error
• func Wrap(err error, message string) error
• func WrapC(err error, code int, format string, args ...interface{}) error
• func Wrapf(err error, format string, args ...interface{}) error
• type Coder
  • func ParseCoder(err error) Coder
• type Frame
  • func (f Frame) Format(s fmt.State, verb rune)
  • func (f Frame) MarshalText() ([]byte, error)
• type StackTrace
  • func (st StackTrace) Format(s fmt.State, verb rune)

Functions

func As

func As(err error, target interface{}) bool

func Cause

func Cause(err error) error

Cause 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 Errorf

func Errorf(format string, args ...interface{}) error

Errorf formats according to a format specifier and returns the string as a value that satisfies error. Errorf also records the stack trace at the point it was called.

func Is

func Is(err, target error) bool

func IsCode

func IsCode(err error, code int) bool

IsCode reports whether any error in err's chain contains the given error code.

func MustRegister

func MustRegister(coder Coder)

MustRegister register a user define error code. It will panic when the same Code already exist.

func New

func New(message string) error

New returns an error with the supplied message. New also records the stack trace at the point it was called.

func Register

func Register(coder Coder)

Register register a user define error code. It will overrid the exist code.

func Unwrap

func Unwrap(err error) error

func WithCode

func WithCode(code int, format string, args ...interface{}) error

func WithMessage

func WithMessage(err error, message string) error

WithMessage annotates err with a new message. If err is nil, WithMessage returns nil.

func WithMessagef

func WithMessagef(err error, format string, args ...interface{}) error

WithMessagef annotates err with the format specifier. If err is nil, WithMessagef returns nil.

func WithStack

func WithStack(err error) error

WithStack annotates err with a stack trace at the point WithStack was called. If err is nil, WithStack returns nil.

func Wrap

func Wrap(err error, message string) error

Wrap returns an error annotating err with a stack trace at the point Wrap is called, and the supplied message. If err is nil, Wrap returns nil.

func WrapC

func WrapC(err error, code int, format string, args ...interface{}) error

func Wrapf

func Wrapf(err error, format string, args ...interface{}) error

Wrapf returns an error annotating err with a stack trace at the point Wrapf is called, and the format specifier. If err is nil, Wrapf returns nil.

Types

type Coder

type Coder interface {
	// HTTP status that should be used for the associated error code.
	HTTPStatus() int

	// External (user) facing error text.
	String() string

	// Code returns the code of the coder
	Code() int
}

Coder defines an interface for an error code detail information.

func ParseCoder

func ParseCoder(err error) Coder

ParseCoder parse any error into *withCode. nil error will return nil direct. None withStack error will be parsed as ErrUnknown.

type Frame

type Frame uintptr

Frame represents a program counter inside a stack frame. For historical reasons if Frame is interpreted as a uintptr its value represents the program counter + 1.

func (Frame) Format

func (f Frame) Format(s fmt.State, verb rune)

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

func (Frame) MarshalText

func (f Frame) MarshalText() ([]byte, error)

MarshalText formats a stacktrace Frame as a text string. The output is the same as that of fmt.Sprintf("%+v", f), but without newlines or tabs.

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.