Documentation
¶
Index ¶
- func FromGRPCStatus(st *status.Status, from, to service.Name) error
- type AbortError
- type Error
- type Factory
- func (f *Factory) Custom(msg string) errors_api.Error
- func (f *Factory) FailedPrecondition(message string) errors_api.Error
- func (f *Factory) Internal(err error) errors_api.Error
- func (f *Factory) InvalidArgument(err error) errors_api.Error
- func (f *Factory) NotFound() errors_api.Error
- func (f *Factory) PermissionDenied() errors_api.Error
- func (f *Factory) RPC(err error, destination string) errors_api.Error
- type FactoryOptions
- type Kind
- type ServiceError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AbortError ¶
func NewAbortError ¶
func NewAbortError(message string, err error) *AbortError
NewAbortError creates an error that the API Start call must return internally.
func (*AbortError) Error ¶
func (s *AbortError) Error() string
type Error ¶
type Error struct {
Code int32 `json:"code"`
ServiceName string `json:"service_name,omitempty"`
Message string `json:"message,omitempty"`
Destination string `json:"destination,omitempty"`
Kind Kind `json:"kind"`
SubLevelError string `json:"details,omitempty"`
}
Error is the framework error type that a service handler should return to keep a standard error between services.
type Factory ¶
type Factory struct {
// contains filtered or unexported fields
}
func NewFactory ¶
func NewFactory(options FactoryOptions) *Factory
NewFactory creates a new Factory object.
func (*Factory) Custom ¶
func (f *Factory) Custom(msg string) errors_api.Error
Custom lets a service set a custom error kind for its errors. Internally, it will be treated as an Internal error.
func (*Factory) FailedPrecondition ¶
func (f *Factory) FailedPrecondition(message string) errors_api.Error
FailedPrecondition sets that the current error is related to an internal condition which wasn't satisfied.
func (*Factory) Internal ¶
func (f *Factory) Internal(err error) errors_api.Error
Internal sets that the current error is related to an internal service error.
func (*Factory) InvalidArgument ¶
func (f *Factory) InvalidArgument(err error) errors_api.Error
InvalidArgument sets that the current error is related to an argument that didn't follow validation rules.
func (*Factory) NotFound ¶
func (f *Factory) NotFound() errors_api.Error
NotFound sets that the current error is related to some data not being found, probably in the database.
func (*Factory) PermissionDenied ¶
func (f *Factory) PermissionDenied() errors_api.Error
PermissionDenied sets that the current error is related to a client trying to access a resource without having permission to do so.
type FactoryOptions ¶
type FactoryOptions struct {
ServiceName string
Logger logger_api.LoggerAPI
}
type ServiceError ¶
type ServiceError struct {
// contains filtered or unexported fields
}
ServiceError is a structure that holds internal error details to improve error log description for the end-user, and it implements the errorApi.Error interface.
func (*ServiceError) Kind ¶
func (s *ServiceError) Kind() string
func (*ServiceError) WithAttributes ¶
func (s *ServiceError) WithAttributes(attrs ...logger_api.Attribute) errors_api.Error
func (*ServiceError) WithCode ¶
func (s *ServiceError) WithCode(code errors_api.Code) errors_api.Error
Source Files