ecode

Documentation

Index

• Constants
• func StatusText(code int) string
• type ErrorCode
  • func New(err error) ErrorCode
• type Status
  • func Error(code int, message string, objects ...interface{}) *Status
  • func Errorf(code int, format string, args ...interface{}) *Status
  • func (s *Status) Code() int
  • func (s *Status) Details() []interface{}
  • func (s *Status) Error() string
  • func (s *Status) Message() string
  • func (s *Status) WithDetails(objects ...interface{}) *Status

Constants

const (
	StatusOK    = 0
	StatusError = 1
)

Functions

func StatusText

func StatusText(code int) string

Types

type ErrorCode

type ErrorCode interface {
	// sometimes Error return Code in string form
	// NOTE: don't use Error in monitor report even it also work for now
	Error() string
	// Code get error code.
	Code() int
	// Message get code message.
	Message() string
	//Detail get error detail,it may be nil.
	Details() []interface{}
}

Codes ecode error interface which has a code & message.

func New

func New(err error) ErrorCode

type Status

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

func Error

func Error(code int, message string, objects ...interface{}) *Status

Error new status with code and message

func Errorf

func Errorf(code int, format string, args ...interface{}) *Status

Errorf new status with code and message

func (*Status) Code

func (s *Status) Code() int

Code return error code

func (*Status) Details

func (s *Status) Details() []interface{}

Details return error details

func (*Status) Error

func (s *Status) Error() string

Error implement error

func (*Status) Message

func (s *Status) Message() string

Message return error message for developer

func (*Status) WithDetails

func (s *Status) WithDetails(objects ...interface{}) *Status

WithDetails WithDetails