errorsx

Documentation

Index

• func HTTPStatus(code Code) int
• func IsCode(err error, code Code) bool
• func WithCode(err error, code Code) error
• type Code
  • func CodeOf(err error) Code

Functions

func HTTPStatus

func HTTPStatus(code Code) int

HTTPStatus maps a Code to its canonical HTTP status code.

func IsCode

func IsCode(err error, code Code) bool

IsCode reports whether err carries the given Code.

func WithCode

func WithCode(err error, code Code) error

WithCode wraps err with a Code. Preserves errors.Is / errors.As chains.

Types

type Code

type Code string

Code is a machine-readable error category.

const (
	CodeInvalidArgument Code = "invalid_argument"
	CodeNotFound        Code = "not_found"
	CodeConflict        Code = "conflict"
	CodeUnauthorized    Code = "unauthorized"
	CodeForbidden       Code = "forbidden"
	CodeDeadline        Code = "deadline"
	CodeUnavailable     Code = "unavailable"
	CodeInternal        Code = "internal"
)

func CodeOf

func CodeOf(err error) Code

CodeOf returns the Code attached to err. Unknown errors return CodeInternal.