errors

Documentation

Index

• Constants
• func Code(err error) string
• func Message(err error) string
• func New(text string) error
• type Error
  • func ToError(err interface{}) *Error
  • func (e *Error) Error() string

Constants

const (
	// CONFLICT - An action cannot be performed.
	CONFLICT = "conflict"
	// INTERNAL - Error within Go Mail
	INTERNAL = "internal" // Internal error
	// INVALID - Validation failed
	INVALID = "invalid" // Validation failed
	// API - Error in the http request.
	API = "api"
	// Prefix is the string prefixed to an error message.
	Prefix = "go-mail"
	// GlobalError is a general message when no error message
	// has been found.
	GlobalError = "An error has occurred."
)

Application error codes.

Functions

func Code

func Code(err error) string

Code returns the code of the root error, if available. Otherwise, returns INTERNAL.

func Message

func Message(err error) string

Message returns the human-readable message of the error, if available. Otherwise, returns a generic error message.

func New

func New(text string) error

New is a wrapper for the stdlib new function.

Types

type Error

type Error struct {
	Code      string `json:"code"`
	Message   string `json:"message"`
	Operation string `json:"operation"`
	Err       error  `json:"error"`
}

Error defines a standard application error.

func ToError

func ToError(err interface{}) *Error

ToError Returns a Go Mail error from input. If The type is not of type Error, nil will be returned.

func (*Error) Error

func (e *Error) Error() string

Error returns the string representation of the error message.