errors

Documentation

Overview

Package errors provides functions to create high quality gRPC status messages for reporting failures.

Package errors provides functions to create high quality gRPC status messages for reporting failures.

Index

• func AddDetail(st *status.Status, detail proto.Message) *status.Status
• func AddRetryInfo(st *status.Status, duration time.Duration) *status.Status
• func BadValue(fieldName string, fieldValue interface{}) error
• func InternalError(err error) error
• func NotFound(fieldName string, id string) error
• func RequiredField(fieldName string) error
• func WithCode(code codes.Code, format string) error
• func WithCodef(code codes.Code, format string, args ...interface{}) error
• func Wrap(err error) error
• func WrapWithCode(err error, code codes.Code, msg string) error
• func WrapWithCodef(err error, code codes.Code, format string, args ...interface{}) error

Functions

func AddDetail

func AddDetail(st *status.Status, detail proto.Message) *status.Status

AddDetail to gRPC Status message.

func AddRetryInfo

func AddRetryInfo(st *status.Status, duration time.Duration) *status.Status

AddRetryInfo annotates an error status with a retry duration.

func BadValue

func BadValue(fieldName string, fieldValue interface{}) error

BadValue returns an error indicating a field did not have a good value.

func InternalError

func InternalError(err error) error

InternalError returns an error with raw details.

func NotFound

func NotFound(fieldName string, id string) error

NotFound returns an error indicating which item was not in the database.

func RequiredField

func RequiredField(fieldName string) error

RequiredField returns an error indicating a field did not have a value.

func WithCode

func WithCode(code codes.Code, format string) error

WithCode creates a gRPC status error with associated call stack.

func WithCodef

func WithCodef(code codes.Code, format string, args ...interface{}) error

WithCodef creates a gRPC status error with associated call stack.

func Wrap

func Wrap(err error) error

Wrap the error with a gRPC status error, retain the call stack.

func WrapWithCode

func WrapWithCode(err error, code codes.Code, msg string) error

WrapWithCode the error with a gRPC status error, retain the call stack.

func WrapWithCodef

func WrapWithCodef(err error, code codes.Code, format string, args ...interface{}) error

WrapWithCodef the error with a gRPC status error, retain the call stack.