ecode

README

ecode

error code handle

Documentation

Index

• Constants
• Variables
• type Error
  • func AnalyseError(err error) (e2 *Error)
  • func DeepClone(err *Error) *Error
  • func FromError(err error) *Error
  • func New(code int, reason string, message string) *Error
  • func (e *Error) Code() int
  • func (e *Error) Equal(code int, reason ...string) bool
  • func (e *Error) Error() string
  • func (e *Error) GRPCStatus() *status.Status
  • func (e *Error) Is(err error) bool
  • func (e *Error) Message() string
  • func (e *Error) Reason() string
  • func (e *Error) Unwrap() error
  • func (e *Error) WithCause(cause error) *Error
  • func (e *Error) WithMetadata(md map[string]string) *Error
• type Status
  • func (*Status) Descriptor() ([]byte, []int)
  • func (x *Status) GetCode() int32
  • func (x *Status) GetMessage() string
  • func (x *Status) GetMetadata() map[string]string
  • func (x *Status) GetReason() string
  • func (*Status) ProtoMessage()
  • func (x *Status) ProtoReflect() protoreflect.Message
  • func (x *Status) Reset()
  • func (x *Status) String() string

Constants

const (
	// UnknownCode is unknown code for error info.
	UnknownCode = http.StatusInternalServerError
	// UnknownReason is unknown reason for error info.
	UnknownReason = ""
	// ClientClosed is non-standard http status code,
	// which defined by nginx.
	// https://httpstatus.in/499/
	ClientClosed = 499
)

Variables

var (
	// base error
	Success               = New(http.StatusOK, "SUCCESS", "success")
	RequestErr            = New(http.StatusBadRequest, "PARAM_ERROR", "request param error")
	UnauthorizedErr       = New(http.StatusUnauthorized, "SIGN_ERROR", "sign error")
	ForbiddenErr          = New(http.StatusForbidden, "NO_AUTH", "no auth")
	NotFoundErr           = New(http.StatusNotFound, "RESOURCE_NOT_FOUND", "resource not found")
	TooManyRequestErr     = New(http.StatusTooManyRequests, "RATELIMIT_EXCEEDED", "ratelimit exceeded")
	ServerErr             = New(http.StatusInternalServerError, "SERVER_ERROR", "server error")
	BadGatewayErr         = New(http.StatusBadGateway, "SERVICE_UNAVAILABLE", "service offline, unavailable")
	ServiceUnavailableErr = New(http.StatusServiceUnavailable, "SERVICE_UNAVAILABLE", "service protected, unavailable")
)

var DefaultConverter = statusConverter{}

DefaultConverter default converter.

var File_errors_proto protoreflect.FileDescriptor

Types

type Error

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

Error struct

func AnalyseError

func AnalyseError(err error) (e2 *Error)

AnalyseError analyse error info

func DeepClone

func DeepClone(err *Error) *Error

DeepClone deep clone error to a new error.

func FromError

func FromError(err error) *Error

FromError try to convert an error to *Error. It supports wrapped errors.

func New

func New(code int, reason string, message string) *Error

New returns an error object for the code, message.

func (*Error) Code

func (e *Error) Code() int

Code returns the code of the error.

func (*Error) Equal

func (e *Error) Equal(code int, reason ...string) bool

Equal matches error from code and reason.

func (*Error) Error

func (e *Error) Error() string

func (*Error) GRPCStatus

func (e *Error) GRPCStatus() *status.Status

GRPCStatus returns the Status represented by error.

func (*Error) Is

func (e *Error) Is(err error) bool

Is matches each error in the chain with the target value.

func (*Error) Message

func (e *Error) Message() string

Message returns the message of the error.

func (*Error) Reason

func (e *Error) Reason() string

Reason returns the reason of the error.

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap provides compatibility for Go 1.13 error chains.

func (*Error) WithCause

func (e *Error) WithCause(cause error) *Error

WithCause with the underlying cause of the error.

func (*Error) WithMetadata

func (e *Error) WithMetadata(md map[string]string) *Error

WithMetadata with an MD formed by the mapping of key, value.

type Status

type Status struct {
	Code     int32             `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	Reason   string            `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	Message  string            `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Status) Descriptor

func (*Status) Descriptor() ([]byte, []int)

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetCode

func (x *Status) GetCode() int32

func (*Status) GetMessage

func (x *Status) GetMessage() string

func (*Status) GetMetadata

func (x *Status) GetMetadata() map[string]string

func (*Status) GetReason

func (x *Status) GetReason() string

func (*Status) ProtoMessage

func (*Status) ProtoMessage()

func (*Status) ProtoReflect

func (x *Status) ProtoReflect() protoreflect.Message

func (*Status) Reset

func (x *Status) Reset()

func (*Status) String

func (x *Status) String() string