errutil

Documentation

Index

• func HTTPError(ctx context.Context, w http.ResponseWriter, err error) bool
• func IsLimitError(err error) bool
• func MapDBError(err error) error
• func ScrubError(err error) (bool, error)
• type LimitError
• type SafeError
  • func (SafeError) ClientError() bool
  • func (err SafeError) Error() string

Functions

func HTTPError

func HTTPError(ctx context.Context, w http.ResponseWriter, err error) bool

HTTPError will respond in a standard way when err != nil. If err is nil, false is returned, true otherwise.

func IsLimitError

func IsLimitError(err error) bool

IsLimitError will determine if an error's cause is a limit.Error.

func MapDBError

func MapDBError(err error) error

MapDBError will map known DB errors (like unique names) to a valiation error

func ScrubError

func ScrubError(err error) (bool, error)

ScrubError will replace an err with a generic one if it is not a validation error. The boolean value indicates if the error was scrubbed (replaced with a safe one).

Types

type LimitError

type LimitError interface {
	error
	Max() int
	ID() limit.ID
	Limit() bool
}

LimitError represents an error caused by a configured system limit.

type SafeError

type SafeError string

SafeError is an error string, safe to return to the client.

func (SafeError) ClientError

func (SafeError) ClientError() bool

ClientError always returns true.

func (SafeError) Error

func (err SafeError) Error() string