errors

package

v0.0.0-...-5d0ab0d Latest Latest Go to latest Published: Feb 15, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

cnb.cool/ifree/dev/micro

Links

Open Source Insights

Documentation ¶

Overview ¶

Package errors provides a way to return detailed information for an RPC request error. The error is normally JSON encoded.

Index ¶

Variables
func BadRequest(id, format string, a ...interface{}) error
func Conflict(id, format string, a ...interface{}) error
func Equal(err1 error, err2 error) bool
func Forbidden(id, format string, a ...interface{}) error
func InternalServerError(id, format string, a ...interface{}) error
func MethodNotAllowed(id, format string, a ...interface{}) error
func New(id, detail string, code int32) error
func NotFound(id, format string, a ...interface{}) error
func Timeout(id, format string, a ...interface{}) error
func Unauthorized(id, format string, a ...interface{}) error
type Error
type MultiError
- func NewMultiError() *MultiError

Constants ¶

This section is empty.

Variables ¶

View Source

var File_errors_errors_proto protoreflect.FileDescriptor

Functions ¶

func BadRequest ¶

func BadRequest(id, format string, a ...interface{}) error

BadRequest generates a 400 error.

func Conflict ¶

func Conflict(id, format string, a ...interface{}) error

Conflict generates a 409 error.

func Equal ¶

func Equal(err1 error, err2 error) bool

Equal tries to compare errors.

func Forbidden ¶

func Forbidden(id, format string, a ...interface{}) error

Forbidden generates a 403 error.

func InternalServerError ¶

func InternalServerError(id, format string, a ...interface{}) error

InternalServerError generates a 500 error.

func MethodNotAllowed ¶

func MethodNotAllowed(id, format string, a ...interface{}) error

MethodNotAllowed generates a 405 error.

func New ¶

func New(id, detail string, code int32) error

New generates a custom error.

func NotFound ¶

func NotFound(id, format string, a ...interface{}) error

NotFound generates a 404 error.

func Timeout ¶

func Timeout(id, format string, a ...interface{}) error

Timeout generates a 408 error.

func Unauthorized ¶

func Unauthorized(id, format string, a ...interface{}) error

Unauthorized generates a 401 error.

Types ¶

type Error ¶

type Error struct {
	Id     string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Code   int32  `protobuf:"varint,2,opt,name=code,proto3" json:"code,omitempty"`
	Detail string `protobuf:"bytes,3,opt,name=detail,proto3" json:"detail,omitempty"`
	Status string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func As ¶

func As(err error) (*Error, bool)

As finds the first error in err's chain that matches *Error.

func FromError ¶

func FromError(err error) *Error

FromError try to convert go error to *Error.

func Parse ¶

func Parse(err string) *Error

Parse tries to parse a JSON string into an error. If that fails, it will set the given string as the error detail.

func (*Error) Descriptor deprecated

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) Error ¶

func (e *Error) Error() string

func (*Error) GetCode ¶

func (x *Error) GetCode() int32

func (*Error) GetDetail ¶

func (x *Error) GetDetail() string

func (*Error) GetId ¶

func (x *Error) GetId() string

func (*Error) GetStatus ¶

func (x *Error) GetStatus() string

func (*Error) ProtoMessage ¶

func (*Error) ProtoMessage()

func (*Error) ProtoReflect ¶

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

func (*Error) Reset ¶

func (x *Error) Reset()

func (*Error) String ¶

func (x *Error) String() string

type MultiError ¶

type MultiError struct {
	Errors []*Error `protobuf:"bytes,1,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

func NewMultiError ¶

func NewMultiError() *MultiError

func (*MultiError) Append ¶

func (e *MultiError) Append(err ...*Error)

func (*MultiError) Descriptor deprecated

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

Deprecated: Use MultiError.ProtoReflect.Descriptor instead.

func (*MultiError) Error ¶

func (e *MultiError) Error() string

func (*MultiError) GetErrors ¶

func (x *MultiError) GetErrors() []*Error

func (*MultiError) HasErrors ¶

func (e *MultiError) HasErrors() bool

func (*MultiError) ProtoMessage ¶

func (*MultiError) ProtoMessage()

func (*MultiError) ProtoReflect ¶

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

func (*MultiError) Reset ¶

func (x *MultiError) Reset()

func (*MultiError) String ¶

func (x *MultiError) String() string

Source Files ¶

errors.go
errors.pb.go
errors.pb.micro.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL