status

Documentation

Index

• func Error(c codes.Code, msg string) error
• func ErrorProto(s *msg.Status) error
• func Errorf(c codes.Code, format string, a ...interface{}) error
• type Status
  • func Convert(err error) *Status
  • func FromError(err error) (s *Status, ok bool)
  • func FromProto(s *msg.Status) *Status
  • func New(c codes.Code, message string) *Status
  • func Newf(c codes.Code, format string, a ...interface{}) *Status
  • func (s *Status) Code() codes.Code
  • func (s *Status) Err() error
  • func (s *Status) Message() string
  • func (s *Status) Proto() *msg.Status

Functions

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 *msg.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 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

func Convert(err error) *Status

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

func FromError

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

FromError returns a Status representing err if it was produced from this package, otherwise it returns nil, false.

func FromProto

func FromProto(s *msg.Status) *Status

FromProto returns a Status representing s.

func New

func New(c codes.Code, message 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...)).

func (*Status) Code

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

Code returns the status code contained in s.

func (*Status) Err

func (s *Status) Err() error

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

func (*Status) Message

func (s *Status) Message() string

Message returns the message contained in s.

func (*Status) Proto

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

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