Documentation
¶
Index ¶
- Constants
- Variables
- func As(err error, target interface{}) bool
- func Code(err error) int
- func Is(err, target error) bool
- func IsBadRequest(err error) bool
- func IsClientClosed(err error) bool
- func IsConflict(err error) bool
- func IsForbidden(err error) bool
- func IsGatewayTimeout(err error) bool
- func IsInternalServer(err error) bool
- func IsNotFound(err error) bool
- func IsServiceUnavailable(err error) bool
- func IsUnauthorized(err error) bool
- func Reason(err error) string
- func Unwrap(err error) error
- type Error
- func BadRequest(reason, message string) *Error
- func ClientClosed(reason, message string) *Error
- func Conflict(reason, message string) *Error
- func Errorf(code int, reason, format string, a ...interface{}) *Error
- func Forbidden(reason, message string) *Error
- func FromError(err error) *Error
- func GatewayTimeout(reason, message string) *Error
- func InternalServer(reason, message string) *Error
- func New(code int, reason, message string) *Error
- func NotFound(reason, message string) *Error
- func ServiceUnavailable(reason, message string) *Error
- func Unauthorized(reason, message string) *Error
- func (x *Error) AddMetadata(mp map[string]string) *Error
- func (*Error) Descriptor() ([]byte, []int)deprecated
- func (x *Error) Error() string
- func (x *Error) GRPCStatus() *status.Status
- func (x *Error) GetCode() int32
- func (x *Error) GetMessage() string
- func (x *Error) GetMetadata() map[string]string
- func (x *Error) GetReason() string
- func (x *Error) Is(target error) bool
- func (*Error) ProtoMessage()
- func (x *Error) ProtoReflect() protoreflect.Message
- func (x *Error) Reset()
- func (x *Error) StatusCode() int
- func (x *Error) String() string
Constants ¶
const ( // UnknownCode is unknown code for error info. UnknownCode = 500 // UnknownReason is unknown reason for error info. UnknownReason = "" )
Variables ¶
var ErrDetails = errors.New("no error details for status with code OK")
var File_errors_proto protoreflect.FileDescriptor
Functions ¶
func IsBadRequest ¶
IsBadRequest determines if err is an error which indicates a BadRequest error. It supports wrapped errors.
func IsClientClosed ¶
IsClientClosed determines if err is an error which indicates a IsClientClosed error. It supports wrapped errors.
func IsConflict ¶
IsConflict determines if err is an error which indicates a Conflict error. It supports wrapped errors.
func IsForbidden ¶
IsForbidden determines if err is an error which indicates a Forbidden error. It supports wrapped errors.
func IsGatewayTimeout ¶
IsGatewayTimeout determines if err is an error which indicates a GatewayTimeout error. It supports wrapped errors.
func IsInternalServer ¶
IsInternalServer determines if err is an error which indicates an Internal error. It supports wrapped errors.
func IsNotFound ¶
IsNotFound determines if err is an error which indicates an NotFound error. It supports wrapped errors.
func IsServiceUnavailable ¶
IsServiceUnavailable determines if err is an error which indicates a Unavailable error. It supports wrapped errors.
func IsUnauthorized ¶
IsUnauthorized determines if err is an error which indicates a Unauthorized error. It supports wrapped errors.
Types ¶
type Error ¶
type Error struct {
// code: status code
Code int32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
// reason:
Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
// message:
Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
// metadata:
Metadata map[string]string `` /* 157-byte string literal not displayed */
// contains filtered or unexported fields
}
func BadRequest ¶
BadRequest new BadRequest error that is mapped to a 400 response.
func ClientClosed ¶
ClientClosed new ClientClosed error that is mapped to a HTTP 499 response.
func GatewayTimeout ¶
GatewayTimeout new GatewayTimeout error that is mapped to a HTTP 504 response.
func InternalServer ¶
InternalServer new InternalServer error that is mapped to a 500 response.
func ServiceUnavailable ¶
ServiceUnavailable new ServiceUnavailable error that is mapped to a HTTP 503 response.
func Unauthorized ¶
Unauthorized new Unauthorized error that is mapped to a 401 response.
func (*Error) AddMetadata ¶
AddMetadata 增加metadata
func (*Error) Descriptor
deprecated
func (*Error) GetMessage ¶
func (*Error) GetMetadata ¶
func (*Error) ProtoMessage ¶
func (*Error) ProtoMessage()
func (*Error) ProtoReflect ¶
func (x *Error) ProtoReflect() protoreflect.Message
Source Files
Directories