errors

Documentation

Index

• Variables
• func As(err error, target any) bool
• func CreateErrorFn(status int) func(msgs ...any) *Error
• func Is(err, target error) bool
• type Error
  • func From(err error) *Error
  • func GetErrorByStatus(status int, err error) *Error
  • func New(message string, extras ...string) *Error
  • func (e *Error) Error() string
  • func (e *Error) MarshalJSON() ([]byte, error)
  • func (e *Error) Messagef(format string, a ...any) *Error
  • func (e *Error) Trace() error
  • func (e *Error) Unwrap() error
  • func (e *Error) Wrap(target error) error

Variables

var (
	InternalServerError = CreateErrorFn(http.StatusInternalServerError)
	Unauthorized        = CreateErrorFn(http.StatusUnauthorized)
	Unauthenticated     = CreateErrorFn(http.StatusUnauthorized)
	BadRequest          = CreateErrorFn(http.StatusBadRequest)
	Forbidden           = CreateErrorFn(http.StatusForbidden)
	NotFound            = CreateErrorFn(http.StatusNotFound)
	BadGateway          = CreateErrorFn(http.StatusBadGateway)
	UnprocessableEntity = CreateErrorFn(http.StatusUnprocessableEntity)
)

Functions

func As

func As(err error, target any) bool

As finds the first error in err's chain that matches target, and if so, sets

func CreateErrorFn

func CreateErrorFn(status int) func(msgs ...any) *Error

func Is

func Is(err, target error) bool

Is reports whether any error in err's chain matches target.

Types

type Error

type Error struct {
	Status  int    `json:"-"`
	Code    string `json:"code,omitempty"`
	Message string `json:"message"`
	Detail  string `json:"detail,omitempty"`
	// contains filtered or unexported fields
}

Error is error object.

func From

func From(err error) *Error

From is constructor to create error object.

func GetErrorByStatus

func GetErrorByStatus(status int, err error) *Error

func New

func New(message string, extras ...string) *Error

New creates new error object. Example: errors.New("Login failed", "LOGIN_FAILED", "Invalid username or password")

message: error message
extras: error detail and error code

func (*Error) Error

func (e *Error) Error() string

Error is error interface implementation.

func (*Error) MarshalJSON

func (e *Error) MarshalJSON() ([]byte, error)

MarshalJSON is json.Marshaler interface implementation.

func (*Error) Messagef

func (e *Error) Messagef(format string, a ...any) *Error

func (*Error) Trace

func (e *Error) Trace() error

Trace is constructor to wrap error object.

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap returns the result of calling the Unwrap method on err.

func (*Error) Wrap

func (e *Error) Wrap(target error) error

Wrap is constructor to wrap error object.