errorz

Documentation

Index

• func Contains(err error, substr string) bool
• func Errorf(format string, a ...interface{}) error
• func FormatError(s fmt.State, verb rune, err error)
• func HasPrefix(err error, prefix string) bool
• func HasSuffix(err error, suffix string) bool
• func IsRetryable(err error) bool
• func NewErrorf(opts ...ErrorfOption) func(format string, a ...interface{}) error
• func WithRetryable(err error, retryable bool) error
• type ErrorfOption
  • func WithCallerSkip(callerSkip int) ErrorfOption

Functions

func Contains

func Contains(err error, substr string) bool

func Errorf

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

Errorf is a function like xerrors.Errorf.

func FormatError

func FormatError(s fmt.State, verb rune, err error)

FormatError is intended to be used as follows:

func (e *customError) Format(s fmt.State, verb rune) {
	errorz.FormatError(s, verb, e.Unwrap())
}

func HasPrefix

func HasPrefix(err error, prefix string) bool

func HasSuffix

func HasSuffix(err error, suffix string) bool

func IsRetryable

func IsRetryable(err error) bool

func NewErrorf

func NewErrorf(opts ...ErrorfOption) func(format string, a ...interface{}) error

NewErrorf returns a function like xerrors.Errorf. It is possible to return a function with different behaviors by passing ErrorfOption as arguments.

func WithRetryable

func WithRetryable(err error, retryable bool) error

Types

type ErrorfOption

type ErrorfOption interface {
	// contains filtered or unexported methods
}

func WithCallerSkip

func WithCallerSkip(callerSkip int) ErrorfOption

WithCallerSkip returns an ErrorfOption that sets the number of stack frames to skip.