errcode

Documentation

Index

• Variables
• func Must(err error, ec *Error) error
• func Wrap(err error, ec *Error) error
• type Error
  • func CreateError(code int, msg string) *Error
  • func (e *Error) Error() string
  • func (e *Error) Is(target error) bool
  • func (e *Error) WithDetail(err error) *Error
  • func (e *Error) WithDetailStr(err string) *Error
  • func (e *Error) WithDetailf(format string, a ...interface{}) *Error
  • func (e *Error) Wrap(err error) error
  • func (e *Error) WrapIfNot(err error) error
• type ErrorGroup
  • func NewErrorGroup(groupCode int, name string) *ErrorGroup
  • func WithErrGroup(groupCode int) *ErrorGroup
  • func (e *ErrorGroup) CreateError(code int, message string) *Error
  • func (e *ErrorGroup) IsInGroup(err error) bool
• type UnmarshalError
  • func (ue *UnmarshalError) UnmarshalJSON(data []byte) error

Variables

var (
	Success             = _eg.CreateError(0, "success")
	UnknownError        = _eg.CreateError(1, "unknown")
	ParameterError      = _eg.CreateError(2, "parameter error")
	InternalError       = _eg.CreateError(3, "internal error")
	RepositoryInitError = _eg.CreateError(4, "repository init error")
)

Functions

func Must

func Must(err error, ec *Error) error

Must make sure error is an error code, if it is not an errcode, wrapper with ec, if it is an errcode, return itself, it is different from Wrap, which always wrapper with ec

func Wrap

func Wrap(err error, ec *Error) error

Wrap make sure error is an error code, if it is not an errcode, wrapper with ec if it is an errcode, wrap message with ec

Types

type Error

type Error struct {
	Code    int
	Message string
	Detail  string
}

Error struct for pb.Error

func CreateError

func CreateError(code int, msg string) *Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) Is

func (e *Error) Is(target error) bool

Is implements errors.Is

func (*Error) WithDetail

func (e *Error) WithDetail(err error) *Error

func (*Error) WithDetailStr

func (e *Error) WithDetailStr(err string) *Error

func (*Error) WithDetailf

func (e *Error) WithDetailf(format string, a ...interface{}) *Error

func (*Error) Wrap

func (e *Error) Wrap(err error) error

Wrap make sure error is an error code, if it is not an errcode, wrapper with ec if it is an errcode, wrap message with ec same as Wrap

func (*Error) WrapIfNot

func (e *Error) WrapIfNot(err error) error

WrapIfNot make sure error is an error code, if it is not an errcode, wrapper with ec, if it is an errcode, return itself, same as Must

type ErrorGroup

type ErrorGroup struct {
	Code int
	Name string
}

func NewErrorGroup

func NewErrorGroup(groupCode int, name string) *ErrorGroup

func WithErrGroup

func WithErrGroup(groupCode int) *ErrorGroup

func (*ErrorGroup) CreateError

func (e *ErrorGroup) CreateError(code int, message string) *Error

func (*ErrorGroup) IsInGroup

func (e *ErrorGroup) IsInGroup(err error) bool

type UnmarshalError

type UnmarshalError struct {
	Error error
}

func (*UnmarshalError) UnmarshalJSON

func (ue *UnmarshalError) UnmarshalJSON(data []byte) error