grpc: Index | Files

package status

import ""

Package status implements errors returned by gRPC. These errors are serialized and transmitted on the wire between server and client, and allow for additional data to be transmitted via the Details field in the status proto. gRPC service handlers should return an error created by this package, and gRPC clients should expect a corresponding error to be returned from the RPC call.

This package upholds the invariants that a non-nil error may not contain an OK code, and an OK code must result in a nil error.


Package Files


func Err Uses

func Err(c codes.Code, msg string) error

Err returns an error representing c and msg. If c is OK, returns nil.

func Errorf Uses

func Errorf(c codes.Code, format string, a ...interface{}) error

Errorf returns Error(c, fmt.Sprintf(format, a...)).

type Error Uses

type Error struct {
    // contains filtered or unexported fields

Error wraps a pointer of a status proto. It implements error and Status, and a nil *Error should never be returned by this package.

func (*Error) Error Uses

func (e *Error) Error() string

func (*Error) GRPCStatus Uses

func (e *Error) GRPCStatus() *Status

GRPCStatus returns the Status represented by se.

func (*Error) Is Uses

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

Is implements future error.Is functionality. A Error is equivalent if the code and message are identical.

type Status Uses

type Status struct {
    // contains filtered or unexported fields

Status represents an RPC status code, message, and details. It is immutable and should be created with New, Newf, or FromProto.

func FromProto Uses

func FromProto(s *spb.Status) *Status

FromProto returns a Status representing s.

func New Uses

func New(c codes.Code, msg string) *Status

New returns a Status representing c and msg.

func Newf Uses

func Newf(c codes.Code, format string, a ...interface{}) *Status

Newf returns New(c, fmt.Sprintf(format, a...)).

func (*Status) Code Uses

func (s *Status) Code() codes.Code

Code returns the status code contained in s.

func (*Status) Details Uses

func (s *Status) Details() []interface{}

Details returns a slice of details messages attached to the status. If a detail cannot be decoded, the error is returned in place of the detail.

func (*Status) Err Uses

func (s *Status) Err() error

Err returns an immutable error representing s; returns nil if s.Code() is OK.

func (*Status) Message Uses

func (s *Status) Message() string

Message returns the message contained in s.

func (*Status) Proto Uses

func (s *Status) Proto() *spb.Status

Proto returns s's status as an spb.Status proto message.

func (*Status) WithDetails Uses

func (s *Status) WithDetails(details ...proto.Message) (*Status, error)

WithDetails returns a new status with the provided details messages appended to the status. If any errors are encountered, it returns nil and the first error encountered.

Package status imports 6 packages (graph) and is imported by 3 packages. Updated 2020-11-03. Refresh now. Tools for package owners.