Documentation

Overview

    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

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func Code

    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

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

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

        func ErrorProto

        func ErrorProto(s *spb.Status) error

          ErrorProto returns an error representing s. If s.Code is OK, returns nil.

          func Errorf

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

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

            Types

            type Status

            type Status = status.Status

              Status references google.golang.org/grpc/internal/status. It represents an RPC status code, message, and details. It is immutable and should be created with New, Newf, or FromProto. https://godoc.org/google.golang.org/grpc/internal/status

              func Convert

              func Convert(err error) *Status

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

                func FromContextError

                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

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

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

                    func FromProto

                    func FromProto(s *spb.Status) *Status

                      FromProto returns a Status representing s.

                      func New

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

                        New returns a Status representing c and msg.

                        func Newf

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

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

                          Source Files