errors

Documentation

Overview

Package errors provides a way to return detailed information for an RPC request error. The error is normally JSON encoded.

Index

• Variables
• func Equal(err1 error, err2 error) bool
• func New(id, msg string, code ErrorCoder) error
• type Error
  • func FromError(err error) *Error
  • func Parse(err string) *Error
  • func (*Error) Descriptor() ([]byte, []int)
  • func (e *Error) Error() string
  • func (x *Error) GetCode() int32
  • func (x *Error) GetMsg() string
  • func (x *Error) GetRequestId() string
  • func (x *Error) GetStatus() string
  • func (*Error) ProtoMessage()
  • func (x *Error) ProtoReflect() protoreflect.Message
  • func (x *Error) Reset()
  • func (x *Error) String() string
• type ErrorCode
  • func (e ErrorCode) Code() int32
  • func (i ErrorCode) String() string
• type ErrorCoder

Variables

var File_errors_proto protoreflect.FileDescriptor

Functions

func Equal

func Equal(err1 error, err2 error) bool

Equal tries to compare errors

func New

func New(id, msg string, code ErrorCoder) error

New generates a custom error.

Types

type Error

type Error struct {
	RequestId string `protobuf:"bytes,1,opt,name=requestId,proto3" json:"requestId,omitempty"`
	Code      int32  `protobuf:"varint,2,opt,name=code,proto3" json:"code,omitempty"`
	Msg       string `protobuf:"bytes,3,opt,name=msg,proto3" json:"msg,omitempty"`
	Status    string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func FromError

func FromError(err error) *Error

FromError try to convert go error to *Error

func Parse

func Parse(err string) *Error

Parse tries to parse a JSON string into an error. If that fails, it will set the given string as the error detail.

func (*Error) Descriptor

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) Error

func (e *Error) Error() string

func (*Error) GetCode

func (x *Error) GetCode() int32

func (*Error) GetMsg

func (x *Error) GetMsg() string

func (*Error) GetRequestId

func (x *Error) GetRequestId() string

func (*Error) GetStatus

func (x *Error) GetStatus() string

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) ProtoReflect

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

func (*Error) Reset

func (x *Error) Reset()

func (*Error) String

func (x *Error) String() string

type ErrorCode

type ErrorCode int32

const (
	OK                  ErrorCode = http.StatusOK
	BadRequest          ErrorCode = http.StatusBadRequest
	Unauthorized        ErrorCode = http.StatusUnauthorized
	Forbidden           ErrorCode = http.StatusForbidden
	NotFound            ErrorCode = http.StatusNotFound
	MethodNotAllowed    ErrorCode = http.StatusMethodNotAllowed
	Timeout             ErrorCode = http.StatusRequestTimeout
	Conflict            ErrorCode = http.StatusConflict
	InternalServerError ErrorCode = http.StatusInternalServerError
)

func (ErrorCode) Code

func (e ErrorCode) Code() int32

func (ErrorCode) String

func (i ErrorCode) String() string

type ErrorCoder

type ErrorCoder interface {
	String() string
	Code() int32
}

ErrorCoder error code