zerror

Documentation

Index

• func Is(err error, code ...ErrCode) bool
• func New(code ErrCode, text string, w ...External) error
• func Panic(err error)
• func Reuse(err error) error
• func SupText(err error, text string) error
• func TryCatch(fn func() error) (err error)
• func Unwrap(err error, code ErrCode) (error, bool)
• func UnwrapErrors(err error) (errs []string)
• func UnwrapFirst(err error) (ferr error)
• func With(err error, text string, w ...External) error
• func Wrap(err error, code ErrCode, text string, w ...External) error
• type ErrCode
  • func UnwrapCode(err error) (ErrCode, bool)
  • func UnwrapCodes(err error) (codes []ErrCode)
  • func UnwrapFirstCode(err error) (code ErrCode)
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Format(s fmt.State, verb rune)
  • func (e *Error) Stack() string
  • func (e *Error) Unwrap() error
• type External
  • func WrapTag(tag TagKind) External
• type TagKind
  • func GetTag(err error) TagKind
  • func (t TagKind) Text(text string) error
  • func (t TagKind) Wrap(err error, text string) error

Functions

func Is

func Is(err error, code ...ErrCode) bool

Is returns if err is Error and its code == code

func New

func New(code ErrCode, text string, w ...External) error

func Panic

func Panic(err error)

Panic if error is not nil, usually used in conjunction with TryCatch

func Reuse

func Reuse(err error) error

Reuse the error

func SupText

func SupText(err error, text string) error

Deprecated: please use zerror.With SupText returns the error text

func TryCatch

func TryCatch(fn func() error) (err error)

TryCatch exception capture

func Unwrap

func Unwrap(err error, code ErrCode) (error, bool)

Unwrap returns if err is Error and its code == code

func UnwrapErrors

func UnwrapErrors(err error) (errs []string)

UnwrapErrors Returns the current all error text

func UnwrapFirst

func UnwrapFirst(err error) (ferr error)

func With

func With(err error, text string, w ...External) error

With returns the inner error's text

func Wrap

func Wrap(err error, code ErrCode, text string, w ...External) error

Wrap wraps err with code

Types

type ErrCode

type ErrCode int32

ErrCode error code type

func UnwrapCode

func UnwrapCode(err error) (ErrCode, bool)

UnwrapCode Returns the current error code

func UnwrapCodes

func UnwrapCodes(err error) (codes []ErrCode)

UnwrapCodes Returns the current all error code

func UnwrapFirstCode

func UnwrapFirstCode(err error) (code ErrCode)

type Error

type Error struct {
	// contains filtered or unexported fields
}

Error wraps err with code

func (*Error) Error

func (e *Error) Error() string

Error returns msg

func (*Error) Format

func (e *Error) Format(s fmt.State, verb rune)

Format formats the frame according to the fmt.Formatter interface

func (*Error) Stack

func (e *Error) Stack() string

Stack returns the stack callers as string

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap returns err inside

type External

type External func(err error) error

func WrapTag

func WrapTag(tag TagKind) External

type TagKind

type TagKind string

const (
	// Empty error
	None TagKind = ""
	// Internal errors, This means that some invariants expected by the underlying system have been broken
	Internal TagKind = "INTERNAL"
	// The operation was cancelled, typically by the caller
	Cancelled TagKind = "CANCELLED"
	// The client specified an invalid argument
	InvalidInput TagKind = "INVALID_INPUT"
	// Some requested entity was not found
	NotFound TagKind = "NOT_FOUND"
	// The caller does not have permission to execute the specified operation
	PermissionDenied TagKind = "PERMISSION_DENIED"
	// The request does not have valid authentication credentials for the operation
	Unauthorized TagKind = "UNAUTHORIZED"
)

func GetTag

func GetTag(err error) TagKind

func (TagKind) Text

func (t TagKind) Text(text string) error

func (TagKind) Wrap

func (t TagKind) Wrap(err error, text string) error