errors

Documentation

Index

• type Error
  • func CreateError(err error, code ErrorCode, msg string) Error
  • func Errorf(code ErrorCode, fmt string, args ...interface{}) Error
  • func GetError(err error) (Error, bool)
  • func New(code ErrorCode, msg string) Error
  • func WithMessage(code ErrorCode, err error, msg string) Error
  • func Wrap(code ErrorCode, cause error, msg string) Error
  • func Wrapf(code ErrorCode, cause error, fmt string, args ...interface{}) Error
• type ErrorCode

Types

type Error

type Error interface {
	error

	// Status returns the error code
	ErrorCode() ErrorCode
	// Generate log msg
	GenerateLogMsg() string
	// Generate client error msg
	GenerateClientErrorMsg() string
}

Error extends error with additional context

func CreateError

func CreateError(err error, code ErrorCode, msg string) Error

CreateError returns custom error

func Errorf

func Errorf(code ErrorCode, fmt string, args ...interface{}) Error

Errorf returns a new Error

func GetError

func GetError(err error) (Error, bool)

GetError returns custom error

func New

func New(code ErrorCode, msg string) Error

New returns a new Error

func WithMessage

func WithMessage(code ErrorCode, err error, msg string) Error

WithMessage returns a new Error

func Wrap

func Wrap(code ErrorCode, cause error, msg string) Error

Wrap returns a new Error

func Wrapf

func Wrapf(code ErrorCode, cause error, fmt string, args ...interface{}) Error

Wrapf returns a new Error

type ErrorCode

type ErrorCode int

ErrorCode error code

const (
	// GeneralError generic error
	GeneralError ErrorCode = iota
)