errcode

Documentation

Overview

Package errcode 错误码

Package errcode 错误码标准化

Index

• Variables
• type Error
  • func NewError(code int, msg string) *Error
  • func (e *Error) Code() int
  • func (e *Error) Details() map[string]any
  • func (e *Error) Error() string
  • func (e *Error) Message() string
  • func (e *Error) Messagef(args ...any) string
  • func (e *Error) WithDetails(k string, v any) *Error
  • func (e *Error) WithZeroContext(ctx *zero.Ctx) *Error

Variables

var (
	Success            = NewError(0, "Success")               // Success code 0 means success
	InternalError      = NewError(1000, "Internal error")     // InternalError code 1000 means something has gone wrong
	InvalidParamsError = NewError(1001, "Invalid parameters") // InvalidParamsError code 1001 means parameters are invalid
	NotFoundError      = NewError(1002, "Not found")          // NotFoundError code 1002 means we cannot find something at anywhere
	TimeoutError       = NewError(1003, "Timeout")            // TimeoutError code 1003 means operation timed out

	DataBaseInternalError = NewError(2000, "DataBase internal error") // DataBaseInternalError code 2000 means something has gone wrong with the database
	DataBaseCreateError   = NewError(2001, "DataBase creation error") // DataBaseCreateError code 2001 means creating something error
	DataBaseUpdateError   = NewError(2002, "DataBase update error")   // DataBaseUpdateError code 2002 means updating something error
	DataBaseReadError     = NewError(2003, "DataBase read error")     // DataBaseReadError code 2003 means reading something error
	DataBaseDeleteError   = NewError(2004, "DataBase delete error")   // DataBaseDeleteError code 2004 means deleting something error

	NetworkError            = NewError(3000, "Network error")                  // NetworkError code 3000 means something has gone wrong when doing http request
	ServerNotFoundError     = NewError(3001, "Server not found error")         // ServerNotFoundError code 3001 means we cannot find server at EA gateway
	InvalidAuthError        = NewError(3002, "Invalid map id or invalid auth") // InvalidAuthError code 3002 means map id is invalid or invalid permission
	InvalidPermissionsError = NewError(3003, "Invalid permissions")            // InvalidPermissionsError code 3003 means we don't have permission
	InvalidPlayerError      = NewError(3004, "Invalid player")                 // InvalidPlayerError code 3004 means EA server does not have info of player
	ServerNotStartError     = NewError(3005, "Server does not started")        // ServerNotStartError code 3005 means server is not started yet

	Canceled = NewError(4000, "Operation canceled") // Canceled code 4000 means operation has been canceled
)

Types

type Error

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

Error 错误

func NewError

func NewError(code int, msg string) *Error

NewError 创建一个错误到codes并返回Error指针

func (*Error) Code

func (e *Error) Code() int

Code 返回错误码

func (*Error) Details

func (e *Error) Details() map[string]any

Details 输出错误有关细节

func (*Error) Error

func (e *Error) Error() string

Error 打印错误信息

func (*Error) Message

func (e *Error) Message() string

Message 返回错误信息

func (*Error) Messagef

func (e *Error) Messagef(args ...any) string

Messagef 格式化输出错误信息

func (*Error) WithDetails

func (e *Error) WithDetails(k string, v any) *Error

WithDetails 添加错误细节

func (*Error) WithZeroContext

func (e *Error) WithZeroContext(ctx *zero.Ctx) *Error

WithZeroContext 添加zero.Ctx 相关细节