apierrors

Documentation

Index

• func IsBadRequestError(err error) bool
• func IsConflictError(err error) bool
• func IsForbiddenError(err error) bool
• func IsInternalServerError(err error) bool
• func IsNotFoundError(err error) bool
• func IsUnauthorizedError(err error) bool
• func IsUnknownError(err error) bool
• type APIStatus
  • func AsAPIStatus(err error) APIStatus
• type KnownReason
• type Status
• type StatusError
  • func NewBadRequest(details string) *StatusError
  • func NewConflict(details string) *StatusError
  • func NewForbidden(details string) *StatusError
  • func NewInternalServerError(details string) *StatusError
  • func NewNotFound(details string) *StatusError
  • func NewUnauthorized(details string) *StatusError
  • func (se *StatusError) Error() string
  • func (se *StatusError) Status() Status

Functions

func IsBadRequestError

func IsBadRequestError(err error) bool

IsBadRequestError checks if error is of type `bad request`

func IsConflictError

func IsConflictError(err error) bool

IsConflictError checks if error is of type `conflict`

func IsForbiddenError

func IsForbiddenError(err error) bool

IsForbiddenError checks if error is of type `forbidden`

func IsInternalServerError

func IsInternalServerError(err error) bool

IsInternalServerError checks if error is of type `internal server error`

func IsNotFoundError

func IsNotFoundError(err error) bool

IsNotFoundError checks if error is of type `not found`

func IsUnauthorizedError

func IsUnauthorizedError(err error) bool

IsUnauthorizedError checks if error is of type `unauthorized`

func IsUnknownError

func IsUnknownError(err error) bool

IsUnknownError checks if error is of type `unknown`

Types

type APIStatus

type APIStatus interface {
	Status() Status
}

func AsAPIStatus

func AsAPIStatus(err error) APIStatus

AsAPIStatus checks if the error is of type `APIStatus` and returns nil if not

type KnownReason

type KnownReason int

const (
	KnownReasonBadRequest KnownReason = iota
	KnownReasonUnauthorized
	KnownReasonForbidden
	KnownReasonNotFound
	KnownReasonConflict
	KnownReasonInternalServerError
	KnownReasonUnknown
)

type Status

type Status struct {
	Reason  KnownReason
	Code    int
	Message string
	Details string
}

type StatusError

type StatusError struct {
	ErrStatus Status
}

func NewBadRequest

func NewBadRequest(details string) *StatusError

NewBadRequest creates a new StatusError with error code 400

func NewConflict

func NewConflict(details string) *StatusError

NewConflict creates a new StatusError with error code 409

func NewForbidden

func NewForbidden(details string) *StatusError

NewForbidden creates a new StatusError with error code 403

func NewInternalServerError

func NewInternalServerError(details string) *StatusError

NewInternalServerError creates a new StatusError with error code 500

func NewNotFound

func NewNotFound(details string) *StatusError

NewNotFound creates a new StatusError with error code 404

func NewUnauthorized

func NewUnauthorized(details string) *StatusError

NewUnauthorized creates a new StatusError with error code 401

func (*StatusError) Error

func (se *StatusError) Error() string

func (*StatusError) Status

func (se *StatusError) Status() Status