code

Documentation

Index

• Constants
• Variables
• func New(code int, message string, detail interface{}) gcode.Code
• func WithCode(code gcode.Code, detail interface{}) gcode.Code
• type ApiCode
  • func (c ApiCode) Code() int
  • func (c ApiCode) Detail() interface{}
  • func (c ApiCode) Message() string
  • func (c ApiCode) String() string

Constants

const (
	// MaxStackDepth marks the max stack depth for error back traces.
	MaxStackDepth = 1
)

Variables

var (
	CodeLimitExceed = ApiCode{/* contains filtered or unexported fields */} // is service unavailable due to rate limit exceeded.
)

Functions

func New

func New(code int, message string, detail interface{}) gcode.Code

New creates and returns an error code. Note that it returns an interface object of Code.

func WithCode

func WithCode(code gcode.Code, detail interface{}) gcode.Code

WithCode creates and returns a new error code based on given Code. The code and message is from given `code`, but the detail if from given `detail`.

Types

type ApiCode

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

ApiCode is an implementer for interface Code for internal usage only.

func (ApiCode) Code

func (c ApiCode) Code() int

Code returns the integer number of current error code.

func (ApiCode) Detail

func (c ApiCode) Detail() interface{}

Detail returns the detailed information of current error code, which is mainly designed as an extension field for error code.

func (ApiCode) Message

func (c ApiCode) Message() string

Message returns the brief message for current error code.

func (ApiCode) String

func (c ApiCode) String() string

String returns current error code as a string.