rpcstatus

Documentation

Index

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

Constants

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

These constants are all the rpc error codes.

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 = codes.Code

StatusCode is the type of status codes for grpc.

func Code

func Code(err error) StatusCode

Code returns the status code associated with the error.