errors

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2022 License: MIT Imports: 11 Imported by: 0

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
)
View Source 
const (
	// CodeClientClosed is non-standard http status code,
	// which defined by nginx.
	// https://httpstatus.in/499/
	CodeClientClosed = 499
)

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 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 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 an Unavailable error. It supports wrapped errors.

func IsUnauthorized 

func IsUnauthorized(err error) bool

IsUnauthorized determines if err is an error which indicates an 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 ToGRPCCode 

func ToGRPCCode(code int) codes.Code

ToGRPCCode converts an HTTP error code into the corresponding gRPC response status.

func ToHTTPCode 

func ToHTTPCode(code codes.Code) int

ToHTTPCode converts a gRPC error code into the corresponding HTTP response status.

Types

type Converter 

type Converter interface {
	HTTP2GRPC(http int) codes.Code
	GRPC2HTTP(grpc codes.Code) int
}
var (
	DefaultConverter Converter = statusCodeConverter{}
)

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 an HTTP 499 response.

func Clone 

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 an 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 an 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 

func (e *Error) Unwrap() error

Unwrap provides compatibility for Go 1.13 error chains.

func (*Error) WithCause 

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 

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 

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

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetCode 

func (x *Status) GetCode() int32

func (*Status) GetMessage 

func (x *Status) GetMessage() string

func (*Status) GetMetadata 

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

func (*Status) GetReason 

func (x *Status) GetReason() string

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect 

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

func (*Status) Reset 

func (x *Status) Reset()

func (*Status) String 

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.