usererror

Documentation

Overview

Package usererror creates errors that are expected from a user making a mistake.

Index

• Constants
• type Error
  • func Duplicate(field, value string) *Error
  • func Invalid(message string) *Error
  • func (e *Error) Error() string
• type Reason

Constants

const (
	ReasonDuplicate = "duplicate"
	ReasonInvalid   = "invalid"
)

Error reasons.

Types

type Error

type Error struct {
	Message string
	Reason  Reason
}

Error returns a message to the user.

func Duplicate

func Duplicate(field, value string) *Error

Duplicate creates a new duplicate error.

func Invalid

func Invalid(message string) *Error

Invalid returns a new invalid error.

func (*Error) Error

func (e *Error) Error() string

type Reason

type Reason string

Reason is the reason that the user error occurred.