validation

Documentation

Index

• func Join(elems []error, sep string) string
• func New(field string, msg string) error
• func NewError(field string, msg error) error
• type Errors
  • func (ee *Errors) Add(field string, msg error) *Errors
  • func (ee Errors) Error() string
  • func (ee *Errors) GetErr() error
  • func (ee Errors) Keys() []string
  • func (ee *Errors) MarshalJSON() ([]byte, error)
• type Messages
  • func (mm Messages) Error() string

Functions

func Join

func Join(elems []error, sep string) string

func New

func New(field string, msg string) error

New returns a single validation error for the field with msg.

func NewError

func NewError(field string, msg error) error

NewError returns a single validation error for the field with the embedded error.

Types

type Errors

type Errors map[string]Messages //nolint: errname

Errors maps fields to the list of validation failures.

func (*Errors) Add

func (ee *Errors) Add(field string, msg error) *Errors

Add appends the field and msg to the current list of errors. Add will initialize the Errors object if it is not initialized.

func (Errors) Error

func (ee Errors) Error() string

Error returns the error string of Errors.

func (*Errors) GetErr

func (ee *Errors) GetErr() error

GetErr allows you to use a nil Errors object and return directly. If there are no validation errors it returns nil.

func (Errors) Keys

func (ee Errors) Keys() []string

func (*Errors) MarshalJSON

func (ee *Errors) MarshalJSON() ([]byte, error)

type Messages

type Messages []error //nolint: errname

Messages are the validation failures for a given field.

func (Messages) Error

func (mm Messages) Error() string