README
¶
errcode
errcode adds typed business error codes with protobuf and gRPC compatibility on top of the core errors package.
Quick Start
import (
"github.com/pubgo/funk/v2/errors/errcode"
"github.com/pubgo/funk/v2/proto/errorpb"
)
const notFound = "demo.user.not_found"
func init() {
errcode.MustRegisterErrCode(&errorpb.ErrCode{
Code: 404,
Message: "user not found",
Name: notFound,
StatusCode: errorpb.Code_NotFound,
})
}
func loadUser() error {
code, ok := errcode.LookupErrCode(notFound)
if !ok {
return errcode.NewCodeErr(&errorpb.ErrCode{Name: "demo.internal", Message: "missing code"})
}
return errcode.NewCodeErr(code)
}
Registry API
| Function | Description |
|---|---|
RegisterErrCode(code) |
Register and return an error on duplicate names |
MustRegisterErrCode(code) |
Register and panic on failure |
LookupErrCode(name) |
Clone a registered code by name |
GetErrCodes() |
Return all registered codes |
RegisterErrCodes(code) |
Deprecated alias of MustRegisterErrCode |
Generated protobuf plugins typically call RegisterErrCodes during package init.
Error Construction
| Function | Description |
|---|---|
NewCodeErr(code, details...) |
Create a typed code error |
NewCodeErrWithMsg(code, msg, details...) |
Override the message |
WrapCode(err, code) |
Attach a code to an existing error |
ParseError(err) |
Extract *errorpb.ErrCode from any error |
Protocol Mapping
| Function | Description |
|---|---|
ConvertErr2Status(code) |
Build gRPC status from protobuf code |
Err2GrpcCode(err) |
Map standard errors to gRPC codes |
GrpcCodeToHTTP(code) |
Map gRPC codes to HTTP status |
Http2GrpcCode(status) |
Map HTTP status to gRPC codes |
See Also
Documentation
¶
Overview ¶
Package errcode provides error code handling with gRPC compatibility.
Index ¶
- func CloneAndCheck(code *errorpb.ErrCode) *errorpb.ErrCode
- func ConvertErr2Status(errCode *errorpb.ErrCode) *status.Status
- func Err2GrpcCode(err error) codes.Code
- func GetErrCodes() []*errorpb.ErrCode
- func GrpcCodeToHTTP(code codes.Code) int
- func Http2GrpcCode(code int32) codes.Code
- func IsGrpcAcceptable(err error) bool
- func LookupErrCode(name string) (*errorpb.ErrCode, bool)
- func MustProtoToAny(p proto.Message) *anypb.Any
- func MustRegisterErrCode(code *errorpb.ErrCode)
- func MustStructToAny(p map[string]any) *anypb.Any
- func MustTagsToAny(tags errors.Tags) []*anypb.Any
- func NewCodeErr(code *errorpb.ErrCode, details ...proto.Message) error
- func NewCodeErrWithMap(code *errorpb.ErrCode, details ...map[string]any) error
- func NewCodeErrWithMsg(code *errorpb.ErrCode, msg string, details ...proto.Message) error
- func ParseErrToPb(err error) proto.Message
- func ParseError(err error) *errorpb.ErrCode
- func RegisterErrCode(code *errorpb.ErrCode) error
- func RegisterErrCodes(code *errorpb.ErrCode) error
- func WrapCode(err error, code *errorpb.ErrCode) error
- type ErrCode
- func (t *ErrCode) As(target any) bool
- func (t *ErrCode) Error() string
- func (t *ErrCode) Format(f fmt.State, verb rune)
- func (t *ErrCode) ID() string
- func (t *ErrCode) Is(err error) bool
- func (t *ErrCode) MarshalJSON() ([]byte, error)
- func (t *ErrCode) Proto() proto.Message
- func (t *ErrCode) String() string
- func (t *ErrCode) Unwrap() error
- type ErrorProto
- type GRPCStatus
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CloneAndCheck ¶
CloneAndCheck clones and validates an error code.
func ConvertErr2Status ¶
ConvertErr2Status converts an error code to a gRPC status. Internal conversion, so that when err=nil, OK information is included in monitoring data.
func Err2GrpcCode ¶
Err2GrpcCode converts a standard Go error into its canonical code. Note that this is only used to translate the error returned by the server applications.
func GetErrCodes ¶
GetErrCodes returns all registered error codes.
func GrpcCodeToHTTP ¶
GrpcCodeToHTTP converts a gRPC error code into the corresponding HTTP response status. See: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
func Http2GrpcCode ¶
Http2GrpcCode converts an HTTP status code to a gRPC code.
func IsGrpcAcceptable ¶
IsGrpcAcceptable checks if a gRPC error is acceptable for retry.
func LookupErrCode ¶ added in v2.0.5
LookupErrCode returns a registered error code by name.
func MustRegisterErrCode ¶ added in v2.0.5
MustRegisterErrCode registers an error code and panics on failure.
func NewCodeErrWithMap ¶
func NewCodeErrWithMsg ¶
func ParseErrToPb ¶
func ParseError ¶
ParseError tries to convert an error to *Error. It supports wrapped errors.
func RegisterErrCode ¶ added in v2.0.5
RegisterErrCode registers an error code and returns an error when the name already exists.
func RegisterErrCodes ¶
RegisterErrCodes registers an error code and panics when the name already exists. Deprecated: use RegisterErrCode or MustRegisterErrCode.
Types ¶
type ErrCode ¶
type ErrCode struct {
// contains filtered or unexported fields
}
ErrCode represents an error with code information.
func (*ErrCode) MarshalJSON ¶
type ErrorProto ¶
ErrorProto is an interface for errors that can be converted to protobuf messages.
type GRPCStatus ¶
GRPCStatus is an interface for errors that have gRPC status.
Source Files