errors

Documentation

Index

• Constants
• Variables
• type Code
  • func (c Code) String() string
• type Error
  • func New(c Code, reason, msg string, kvs ...string) *Error
  • func Newf(c Code, reason, format string, a ...interface{}) *Error
  • func UnknownError(err error) *Error
  • func (e *Error) Error() string
  • func (e *Error) Is(err error) bool
  • func (e *Error) WithMetadata(md map[string]string) *Error
• type Status
  • func FromError(err error) *Status
  • func SuccessStatus() *Status
  • func UnknownStatus(err error) *Status
  • func (s *Status) Err() error

Constants

const (
	OK = iota
	Canceled
	Unknown
	InvalidArgument
	DeadlineExceeded
	NotFound
	AlreadyExists
	PermissionDenied
	ResourceExhausted
	FailedPrecondition
	Aborted
	OutOfRange
	Unimplemented
	Internal
	Unavailable
	DataLoss
	Unauthenticated
)

Variables

var (
	SuccessReason  = "SUCCESS"
	SuccessMessage = "success"
	UnknownReason  = "UNKNOWN"
	UnknownMessage = "unknown"
)

Types

type Code

type Code uint32

Code is the error code.

func (Code) String

func (c Code) String() string

String returns the string representation of the status.

type Error

type Error struct {
	*Status
}

Error is a micro error.

func New

func New(c Code, reason, msg string, kvs ...string) *Error

New returns an error with the specified code, reason, message and metadata.

func Newf

func Newf(c Code, reason, format string, a ...interface{}) *Error

Newf returns an error with the specified code, reason and message.

func UnknownError

func UnknownError(err error) *Error

UnknownError returns an error with unknown status.

func (*Error) Error

func (e *Error) Error() string

Error returns the error string.

func (*Error) Is

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

Is returns true if the error is of the specified type.

func (*Error) WithMetadata

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

WithMetadata returns an error with metadata.

type Status

type Status struct {
	Code     Code
	Reason   string
	Message  string
	Metadata map[string]string
}

Status is a micro status.

func FromError

func FromError(err error) *Status

FromError returns a status from an error.

func SuccessStatus

func SuccessStatus() *Status

SuccessStatus returns a success status.

func UnknownStatus

func UnknownStatus(err error) *Status

UnknownStatus returns an unknown status.

func (*Status) Err

func (s *Status) Err() error

Err returns the error.