errors

Documentation

Overview

nolint:gomnd

Index

• Constants
• func As(err error, target interface{}) bool
• func Code(err error) int
• func Errorf(code int, format string, a ...interface{}) error
• func Is(err, target error) bool
• func IsBadRequest(err error) bool
• func IsForbidden(err error) bool
• func IsInternalServer(err error) bool
• func IsNotFound(err error) bool
• func IsUnauthorized(err error) bool
• func Unwrap(err error) error
• type Error
  • func BadRequest(reason, message string) *Error
  • func Forbidden(message string) *Error
  • func FromError(err error) *Error
  • func InternalServer(message string) *Error
  • func New(code int, message string) *Error
  • func NotFound(message string) *Error
  • func Unauthorized(message string) *Error
  • func (e *Error) Error() string
  • func (x *Error) GetCode() int
  • func (x *Error) GetMessage() string
  • func (x *Error) GetMetadata() map[string]string
  • func (e *Error) Is(err error) bool
  • func (e *Error) WithMetadata(md map[string]string) *Error
• type IgnoreError

Constants

const (
	UnknownCode = 500
)

Functions

func As

func As(err error, target interface{}) bool

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, format string, a ...interface{}) error

func Is

func Is(err, target error) bool

func IsBadRequest

func IsBadRequest(err error) bool

func IsForbidden

func IsForbidden(err error) bool

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

func IsUnauthorized

func IsUnauthorized(err error) bool

func Unwrap

func Unwrap(err error) error

Types

type Error

type Error struct {
	Code     int               `json:"code,omitempty"`
	Message  string            `json:"message,omitempty"`
	Metadata map[string]string `json:"metadata,omitempty"`
}

func BadRequest

func BadRequest(reason, message string) *Error

func Forbidden

func Forbidden(message string) *Error

func FromError

func FromError(err error) *Error

FromError try to convert an error to *Error. It supports wrapped errors.

func InternalServer

func InternalServer(message string) *Error

func New

func New(code int, message string) *Error

func NotFound

func NotFound(message string) *Error

func Unauthorized

func Unauthorized(message string) *Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) GetCode

func (x *Error) GetCode() int

func (*Error) GetMessage

func (x *Error) GetMessage() string

func (*Error) GetMetadata

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

func (*Error) Is

func (e *Error) Is(err error) bool

func (*Error) WithMetadata

func (e *Error) WithMetadata(md map[string]string) *Error

type IgnoreError

type IgnoreError interface {
	Ignore() bool
}