errors

package
v2.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 6, 2022 License: MIT Imports: 10 Imported by: 918

Documentation

Overview

nolint:gomnd

Index

Constants

View Source 
const (
	// UnknownCode is unknown code for error info.
	UnknownCode = 500
	// UnknownReason is unknown reason for error info.
	UnknownReason = ""
	// SupportPackageIsVersion1 this constant should not be referenced by any other code.
	SupportPackageIsVersion1 = true
)

Variables

View Source 
var (
	// optional int32 code = 1109;
	E_Code = &file_errors_proto_extTypes[1]
)

Extension fields to descriptorpb.EnumValueOptions.

View Source 
var (
	// optional int32 default_code = 1108;
	E_DefaultCode = &file_errors_proto_extTypes[0]
)

Extension fields to descriptorpb.EnumOptions.

View Source 
var File_errors_proto protoreflect.FileDescriptor

Functions

func As 

func As(err error, target interface{}) bool

As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true.

The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.

An error matches target if the error's concrete value is assignable to the value pointed to by target, or if the error has a method As(interface{}) bool such that As(target) returns true. In the latter case, the As method is responsible for setting target.

As will panic if target is not a non-nil pointer to either a type that implements error, or to any interface type. As returns false if err is nil.

func Code 

func Code(err error) int

Code returns the http code for an error. It supports wrapped errors.

func Errorf 

func Errorf(code int, reason, format string, a ...interface{}) error

Errorf returns an error object for the code, message and error info.

func Is 

func Is(err, target error) bool

Is reports whether any error in err's chain matches target.

The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.

An error is considered to match a target if it is equal to that target or if it implements a method Is(error) bool such that Is(target) returns true.

func IsBadRequest 

func IsBadRequest(err error) bool

IsBadRequest determines if err is an error which indicates a BadRequest error. It supports wrapped errors.

func IsClientClosed 

func IsClientClosed(err error) bool

IsClientClosed determines if err is an error which indicates a IsClientClosed error. It supports wrapped errors.

func IsConflict 

func IsConflict(err error) bool

IsConflict determines if err is an error which indicates a Conflict error. It supports wrapped errors.

func IsForbidden 

func IsForbidden(err error) bool

IsForbidden determines if err is an error which indicates a Forbidden error. It supports wrapped errors.

func IsGatewayTimeout 

func IsGatewayTimeout(err error) bool

IsGatewayTimeout determines if err is an error which indicates a GatewayTimeout error. It supports wrapped errors.

func IsInternalServer 

func IsInternalServer(err error) bool

IsInternalServer determines if err is an error which indicates an Internal error. It supports wrapped errors.

func IsNotFound 

func IsNotFound(err error) bool

IsNotFound determines if err is an error which indicates an NotFound error. It supports wrapped errors.

func IsServiceUnavailable 

func IsServiceUnavailable(err error) bool

IsServiceUnavailable determines if err is an error which indicates a Unavailable error. It supports wrapped errors.

func IsUnauthorized 

func IsUnauthorized(err error) bool

IsUnauthorized determines if err is an error which indicates a Unauthorized error. It supports wrapped errors.

func Reason 

func Reason(err error) string

Reason returns the reason for a particular error. It supports wrapped errors.

func Unwrap 

func Unwrap(err error) error

Unwrap returns the result of calling the Unwrap method on err, if err's type contains an Unwrap method returning error. Otherwise, Unwrap returns nil.

Types

type Error 

type Error struct {
	Status
	// contains filtered or unexported fields
}

Error is a status error.

func BadRequest 

func BadRequest(reason, message string) *Error

BadRequest new BadRequest error that is mapped to a 400 response.

func ClientClosed 

func ClientClosed(reason, message string) *Error

ClientClosed new ClientClosed error that is mapped to a HTTP 499 response.

func Clone added in v2.2.2 

func Clone(err *Error) *Error

Clone deep clone error to a new error.

func Conflict 

func Conflict(reason, message string) *Error

Conflict new Conflict error that is mapped to a 409 response.

func Forbidden 

func Forbidden(reason, message string) *Error

Forbidden new Forbidden error that is mapped to a 403 response.

func FromError 

func FromError(err error) *Error

FromError try to convert an error to *Error. It supports wrapped errors.

func GatewayTimeout 

func GatewayTimeout(reason, message string) *Error

GatewayTimeout new GatewayTimeout error that is mapped to a HTTP 504 response.

func InternalServer 

func InternalServer(reason, message string) *Error

InternalServer new InternalServer error that is mapped to a 500 response.

func New 

func New(code int, reason, message string) *Error

New returns an error object for the code, message.

func Newf 

func Newf(code int, reason, format string, a ...interface{}) *Error

Newf New(code fmt.Sprintf(format, a...))

func NotFound 

func NotFound(reason, message string) *Error

NotFound new NotFound error that is mapped to a 404 response.

func ServiceUnavailable 

func ServiceUnavailable(reason, message string) *Error

ServiceUnavailable new ServiceUnavailable error that is mapped to a HTTP 503 response.

func Unauthorized 

func Unauthorized(reason, message string) *Error

Unauthorized new Unauthorized error that is mapped to a 401 response.

func (*Error) Error 

func (e *Error) Error() string

func (*Error) GRPCStatus 

func (e *Error) GRPCStatus() *status.Status

GRPCStatus returns the Status represented by se.

func (*Error) Is 

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

Is matches each error in the chain with the target value.

func (*Error) Unwrap added in v2.2.2 

func (e *Error) Unwrap() error

Unwrap provides compatibility for Go 1.13 error chains.

func (*Error) WithCause added in v2.2.2 

func (e *Error) WithCause(cause error) *Error

WithCause with the underlying cause of the error.

func (*Error) WithMetadata 

func (e *Error) WithMetadata(md map[string]string) *Error

WithMetadata with an MD formed by the mapping of key, value.

type Status added in v2.2.2 

type Status struct {
	Code     int32             `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	Reason   string            `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	Message  string            `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Status) Descriptor deprecated added in v2.2.2 

func (*Status) Descriptor() ([]byte, []int)

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetCode added in v2.2.2 

func (x *Status) GetCode() int32

func (*Status) GetMessage added in v2.2.2 

func (x *Status) GetMessage() string

func (*Status) GetMetadata added in v2.2.2 

func (x *Status) GetMetadata() map[string]string

func (*Status) GetReason added in v2.2.2 

func (x *Status) GetReason() string

func (*Status) ProtoMessage added in v2.2.2 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect added in v2.2.2 

func (x *Status) ProtoReflect() protoreflect.Message

func (*Status) Reset added in v2.2.2 

func (x *Status) Reset()

func (*Status) String added in v2.2.2 

func (x *Status) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.