codes

package
v2.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 2, 2026 License: MIT Imports: 4 Imported by: 9

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	OK               = NewCode(0, "ok")
	Canceled         = NewCode(1, "canceled")
	Unknown          = NewCode(2, "unknown")
	InvalidArgument  = NewCode(3, "invalid argument")
	DeadlineExceeded = NewCode(4, "deadline exceeded")
	NotFound         = NewCode(5, "not found")
	InternalError    = NewCode(6, "internal error")
	Unauthorized     = NewCode(7, "unauthorized")
	IllegalInvoke    = NewCode(8, "illegal invoke")
	IllegalRequest   = NewCode(9, "illegal request")
	TooManyRequests  = NewCode(10, "too many requests")
)

Functions

This section is empty.

Types

type Code 

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

func Convert 

func Convert(err error) *Code

Convert converts err to a code. It returns OK when err is nil, the carried code when err exposes one, and Unknown when err cannot be parsed.

func NewCode 

func NewCode(code int, message ...string) *Code

NewCode returns a new Code with the given code and an optional message.

func (*Code) Code 

func (c *Code) Code() int

Code returns the error code.

func (*Code) Err 

func (c *Code) Err() error

Err converts the code to an error, or returns nil when c is OK.

func (*Code) Format 

func (c *Code) Format(s fmt.State, verb rune)

Format implements fmt.Formatter.

The %s verb prints the error code and the error message, and %v prints the error code, the error message and the error detail.

func (*Code) Message 

func (c *Code) Message() string

Message returns the error code message.

func (*Code) String 

func (c *Code) String() string

String returns the formatted error code.

func (*Code) WithCode added in v2.1.0 

func (c *Code) WithCode(code int) *Code

WithCode returns a copy of c with the code replaced.

func (*Code) WithMessage added in v2.1.0 

func (c *Code) WithMessage(message string) *Code

WithMessage returns a copy of c with the message replaced.

func (*Code) WithMessagef added in v2.5.0 

func (c *Code) WithMessagef(format string, a ...any) *Code

WithMessagef returns a copy of c with the message formatted by format and a.

type Error 

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

func (*Error) Error 

func (e *Error) Error() string

Error implements the error interface.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.