rpcstatus

Documentation

Index

• func Error(code StatusCode, msg string) error
• func Errorf(code StatusCode, format string, a ...interface{}) error
• type StatusCode
  • func Code(err error) StatusCode

Functions

func Error

func Error(code StatusCode, msg string) error

Error wraps the message with a status code into an error.

func Errorf

func Errorf(code StatusCode, format string, a ...interface{}) error

Errorf : Error :: fmt.Sprintf : fmt.Sprint

Types

type StatusCode

type StatusCode uint64

StatusCode is an enumeration of rpc status codes.

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

These constants are all the rpc error codes. It is important that their numerical values do not change.

func Code

func Code(err error) StatusCode

Code returns the status code associated with the error.