code

Documentation

Index

• Variables
• func MustRegister(coder Coder)
• func Register(coder Coder)
• type Coder
  • func Get(errorCode int) Coder
  • func GetByCode(errorCode int) (Coder, bool)
  • func New(errorCode, httpStatus, correctionFactor int, ...) Coder
  • func NewWithCodeAndMessage(errorCode int, message string, messageCh string) Coder
  • func NewWithInternalError(errorCode, correctionFactor int, message string, messageCh string) Coder
  • func NewWithMessages(errorCode, correctionFactor int, messages []string) Coder
  • func NewWithoutFactorAndRef(errorCode, httpStatus int, message, messageCh string) Coder
  • func NewWithoutRef(errorCode, httpStatus, correctionFactor int, message string, messageCh string) Coder
• type CorrectionFactorCoder
  • func (c *CorrectionFactorCoder) Code() int
  • func (c *CorrectionFactorCoder) ErrorCode() int
  • func (c *CorrectionFactorCoder) HttpStatus() int
  • func (c *CorrectionFactorCoder) Message() string
  • func (c *CorrectionFactorCoder) MessageCh() string
  • func (c *CorrectionFactorCoder) MessageChF(values ...any) string
  • func (c *CorrectionFactorCoder) MessageF(values ...any) string
  • func (c *CorrectionFactorCoder) Messages() []string
  • func (c *CorrectionFactorCoder) MessagesF(values ...any) []string
  • func (c *CorrectionFactorCoder) Reference() string

Variables

var (
	UnknownCoder            = NewWithCodeAndMessage(100000, "An internal server error occurred", "发生内部服务器错误")
	ErrCanceledGrpc         = NewWithCodeAndMessage(100401, "The gRPC framework will generate this error code when cancellation is requested", "grpc错误：请求取消")
	ErrDeadlineExceededGrpc = NewWithCodeAndMessage(100402, "The gRPC framework will generate this error code when the deadline is exceeded", "grpc错误：超过截止日期")
	ErrMissingHeader        = NewWithCodeAndMessage(100403, "Authorization header cannot be empty.", "授权请求头不能为空")
	ErrSignatureInvalid     = NewWithCodeAndMessage(100404, "Authorization signature invalid.", "授权签名无效")
	ErrExpired              = NewWithCodeAndMessage(100405, "Authorization expired.", "授权过期")
	ErrInvalidAuthHeader    = NewWithCodeAndMessage(100406, "Authorization header format is wrong.", "授权请求头格式错误")
)

Functions

func MustRegister

func MustRegister(coder Coder)

MustRegister 注册一个用户定义的错误代码。 如果相同的 Code 已经存在，它将会 panic

func Register

func Register(coder Coder)

Register 用于注册自定义错误码。 如果注册的错误码已经存在，则会覆盖之前的错误码

Types

type Coder

type Coder interface {
	// ErrorCode 错误码
	ErrorCode() int
	// Code 展示的错误码，是真正返回给客户端的错误码
	Code() int
	// HttpStatus 返回http的错误码
	HttpStatus() int
	// Message 返回错误信息
	Message() string
	// MessageCh 返回错误信息
	MessageCh() string
	// MessageF 返回格式化的信息
	MessageF(values ...any) string
	// MessageChF 返回格式化的信息
	MessageChF(values ...any) string
	// Messages 返回所有有的错误信息
	Messages() []string
	// MessagesF 返回所有信息格式化后的信息
	MessagesF(values ...any) []string
	// Reference 返回用户的详细文档
	Reference() string
}

func Get

func Get(errorCode int) Coder

func GetByCode

func GetByCode(errorCode int) (Coder, bool)

func New

func New(errorCode, httpStatus, correctionFactor int, message, messageCh, reference string, messages []string) Coder

New 全部参数的创建函数

func NewWithCodeAndMessage

func NewWithCodeAndMessage(errorCode int, message string, messageCh string) Coder

func NewWithInternalError

func NewWithInternalError(errorCode, correctionFactor int, message string, messageCh string) Coder

func NewWithMessages

func NewWithMessages(errorCode, correctionFactor int, messages []string) Coder

func NewWithoutFactorAndRef

func NewWithoutFactorAndRef(errorCode, httpStatus int, message, messageCh string) Coder

func NewWithoutRef

func NewWithoutRef(errorCode, httpStatus, correctionFactor int, message string, messageCh string) Coder

type CorrectionFactorCoder

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

CorrectionFactorCoder 修正因子的coder，推荐使用NexXXX方法创建

func (*CorrectionFactorCoder) Code

func (c *CorrectionFactorCoder) Code() int

func (*CorrectionFactorCoder) ErrorCode

func (c *CorrectionFactorCoder) ErrorCode() int

func (*CorrectionFactorCoder) HttpStatus

func (c *CorrectionFactorCoder) HttpStatus() int

func (*CorrectionFactorCoder) Message

func (c *CorrectionFactorCoder) Message() string

func (*CorrectionFactorCoder) MessageCh

func (c *CorrectionFactorCoder) MessageCh() string

func (*CorrectionFactorCoder) MessageChF

func (c *CorrectionFactorCoder) MessageChF(values ...any) string

func (*CorrectionFactorCoder) MessageF

func (c *CorrectionFactorCoder) MessageF(values ...any) string

func (*CorrectionFactorCoder) Messages

func (c *CorrectionFactorCoder) Messages() []string

func (*CorrectionFactorCoder) MessagesF

func (c *CorrectionFactorCoder) MessagesF(values ...any) []string

func (*CorrectionFactorCoder) Reference

func (c *CorrectionFactorCoder) Reference() string