code

Documentation

Index

• Constants
• type ErrCode
  • func (coder *ErrCode) Code() int
  • func (coder *ErrCode) HTTPStatus() int
  • func (coder *ErrCode) Reference() string
  • func (coder *ErrCode) String() string

Constants

const (
	// ErrSuccess - 200: OK.
	ErrSuccess int = iota + 100001

	// ErrUnknown - 500: Internal server error.
	ErrUnknown

	// ErrBind - 400: Error occurred while binding the request body to the struct.
	ErrBind

	// ErrValidation - 400: Validation failed.
	ErrValidation

	// ErrTokenInvalid - 401: Token invalid.
	ErrTokenInvalid
)

通用: 基本错误 Code must start with 1xxxxx.

const (
	// ErrEncrypt - 401: Error occurred while encrypting the user password.
	ErrEncrypt int = iota + 100201

	// ErrSignatureInvalid - 401: Signature is invalid.
	ErrSignatureInvalid

	// ErrExpired - 401: Token expired.
	ErrExpired

	// ErrInvalidAuthHeader - 401: Invalid authorization header.
	ErrInvalidAuthHeader

	// ErrMissingHeader - 401: The `Authorization` header was empty.
	ErrMissingHeader

	// ErrorExpired - 401: Token expired.
	ErrorExpired

	// ErrPasswordIncorrect - 401: Password was incorrect.
	ErrPasswordIncorrect

	// ErrPermissionDenied - 403: Permission denied.
	ErrPermissionDenied
)

通用：认证授权类错误.

const (
	// ErrEncodingFailed - 500: Encoding failed due to an error with the data.
	ErrEncodingFailed int = iota + 100301

	// ErrDecodingFailed - 500: Decoding failed due to an error with the data.
	ErrDecodingFailed

	// ErrInvalidJSON - 500: Data is not valid JSON.
	ErrInvalidJSON

	// ErrEncodingJSON - 500: JSON data could not be encoded.
	ErrEncodingJSON

	// ErrDecodingJSON - 500: JSON data could not be decoded.
	ErrDecodingJSON

	// ErrInvalidYaml - 500: Data is not valid Yaml.
	ErrInvalidYaml

	// ErrEncodingYaml - 500: Yaml data could not be encoded.
	ErrEncodingYaml

	// ErrDecodingYaml - 500: Yaml data could not be decoded.
	ErrDecodingYaml
)

通用：编解码类错误.

const (
	// ErrParentMenuExisted - 201: 父菜单id不存在，请确认后再选择.
	ErrParentMenuExisted int = iota + 100501
	// ErrNotAllowCreate - 201: 当上级菜单不是目录时，不允许创建子菜单.菜单类型只能创建按钮子集
	ErrNotAllowCreate
)

菜单类业务错误：

const (
	// ErrDatabase - 500: Database error.
	ErrDatabase int = iota + 100101
)

通用：数据库类错误.

Types

type ErrCode

type ErrCode struct {
	// C refers to the code of the ErrCode.
	C int

	// HTTP status that should be used for the associated error code.
	HTTP int

	// External (user) facing error text.
	Ext string

	// Ref specify the reference document.
	Ref string
}

ErrCode implements `github.com/marmotedu/errors`.Coder interface.

func (*ErrCode) Code

func (coder *ErrCode) Code() int

Code returns the integer code of ErrCode.

func (*ErrCode) HTTPStatus

func (coder *ErrCode) HTTPStatus() int

HTTPStatus returns the associated HTTP status code, if any. Otherwise, returns 200.

func (*ErrCode) Reference

func (coder *ErrCode) Reference() string

Reference returns the reference document.

func (*ErrCode) String

func (coder *ErrCode) String() string

String implements stringer. String returns the external error message, if any.