errdefs

Documentation

Overview

Package errdefs defines the error types that are understood by other packages in this project. Consumers of this project should look here to know how to produce and consume errors for this project.

Index

• func AsInvalidInput(err error) error
• func AsNotFound(err error) error
• func InvalidInput(msg string) error
• func InvalidInputf(format string, args ...interface{}) error
• func IsInvalidInput(err error) bool
• func IsNotFound(err error) bool
• func NotFound(msg string) error
• func NotFoundf(format string, args ...interface{}) error
• type ErrInvalidInput
• type ErrNotFound

Functions

func AsInvalidInput

func AsInvalidInput(err error) error

AsInvalidInput wraps the passed in error to make it of type ErrInvalidInput

Callers should make sure the passed in error has exactly the error message it wants as this function does not decorate the message.

func AsNotFound

func AsNotFound(err error) error

AsNotFound wraps the passed in error to make it of type ErrNotFound

Callers should make sure the passed in error has exactly the error message it wants as this function does not decorate the message.

func InvalidInput

func InvalidInput(msg string) error

InvalidInput makes an ErrInvalidInput from the provided error message

func InvalidInputf

func InvalidInputf(format string, args ...interface{}) error

InvalidInputf makes an ErrInvalidInput from the provided error format and args

func IsInvalidInput

func IsInvalidInput(err error) bool

IsInvalidInput determines if the passed in error is of type ErrInvalidInput

This will traverse the causal chain (`Cause() error`), until it finds an error which implements the `InvalidInput` interface.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound determines if the passed in error is of type ErrNotFound

This will traverse the causal chain (`Cause() error`), until it finds an error which implements the `NotFound` interface.

func NotFound

func NotFound(msg string) error

NotFound makes an ErrNotFound from the provided error message

func NotFoundf

func NotFoundf(format string, args ...interface{}) error

NotFoundf makes an ErrNotFound from the provided error format and args

Types

type ErrInvalidInput

type ErrInvalidInput interface {
	InvalidInput() bool
	error
}

ErrInvalidInput is an error interface which denotes whether the opration failed due to a the resource not being found.

type ErrNotFound

type ErrNotFound interface {
	NotFound() bool
	error
}

ErrNotFound is an error interface which denotes whether the opration failed due to a the resource not being found.