grpc: google.golang.org/grpc/status Index | Files

package status

import "google.golang.org/grpc/status"

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.

Index

Package Files

status.go

func Code Uses

❖
func Code(err error) codes.Code

Code returns the Code of the error if it is a Status error, codes.OK if err is nil, or codes.Unknown otherwise.

func Error Uses

❖
func Error(c codes.Code, msg string) error

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

func ErrorProto Uses

❖
func ErrorProto(s *spb.Status) error

ErrorProto returns an error representing s. If s.Code 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 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 Convert Uses

❖
func Convert(err error) *Status

Convert is a convenience function which removes the need to handle the boolean return value from FromError.

func FromContextError Uses

❖
func FromContextError(err error) *Status

FromContextError converts a context error into a Status. It returns a Status with codes.OK if err is nil, or a Status with codes.Unknown if err is non-nil and not a context error.

func FromError Uses

❖
func FromError(err error) (s *Status, ok bool)

FromError returns a Status representing err if it was produced from this package or has a method `GRPCStatus() *Status`. Otherwise, ok is false and a Status is returned with codes.Unknown and the original error message.

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 8 packages (graph) and is imported by 2178 packages. Updated 2019-07-29. Refresh now. Tools for package owners.