ecode

Documentation

Index

• Variables
• func Equal(a, b Codes) bool
• func EqualError(code Codes, err error) bool
• func Register(cm map[int]string)
• type Code
  • func Error(e int, msg string) Code
  • func Int(i int) Code
  • func New(e int) Code
  • func String(e string) Code
  • func (e Code) Code() int
  • func (e Code) Equal(err error) bool
  • func (e Code) Error() string
  • func (e Code) Message() string
• type Codes
  • func Cause(e error) Codes

Variables

var (
	OK        = Int(0)
	ParamErr  = Int(499)
	ServerErr = Int(500)
)

Functions

func Equal

func Equal(a, b Codes) bool

Equal equal a and b by code int.

func EqualError

func EqualError(code Codes, err error) bool

EqualError equal error

func Register

func Register(cm map[int]string)

Register register ecode message map.

Types

type Code

type Code int

A Code is an int error code spec.

func Error

func Error(e int, msg string) Code

Error returns a ecode.Codes and register associated ecode message NOTE: Error codes and messages should be kept together. ecode must unique in global, the Error will check repeat and then panic.

func Int

func Int(i int) Code

Int parse code int to error.

func New

func New(e int) Code

New new a ecode.Codes by int value. NOTE: ecode must unique in global, the New will check repeat and then panic.

func String

func String(e string) Code

String parse code string to error.

func (Code) Code

func (e Code) Code() int

Code return error code

func (Code) Equal

func (e Code) Equal(err error) bool

Equal for compatible.

func (Code) Error

func (e Code) Error() string

func (Code) Message

func (e Code) Message() string

Message return error message

type Codes

type Codes interface {
	// Error return Code in string form
	Error() string
	// Code get error code.
	Code() int
	// Message get code message.
	Message() string
	// Equal for compatible.
	Equal(error) bool
}

Codes ecode error interface which has a code & message.

func Cause

func Cause(e error) Codes

Cause cause from error to ecode.