validate

README

github.com/markbates/going/validate

This package has moved to https://github.com/markbates/validate.

Documentation

Index

• type Errors
  • func NewErrors() *Errors
  • func Validate(validators ...Validator) *Errors
  • func (v *Errors) Add(key string, msg string)
  • func (v *Errors) Append(ers *Errors)
  • func (v *Errors) Count() int
  • func (v *Errors) Error() string
  • func (v *Errors) Get(key string) []string
  • func (v *Errors) HasAny() bool
  • func (v *Errors) String() string
• type Validator
  • func ValidatorFunc(fn func(errors *Errors)) Validator

Types

type Errors

type Errors struct {
	Errors map[string][]string `json:"errors"`
	Lock   *sync.RWMutex       `json:"-"`
}

Errors holds onto all of the error messages that get generated during the validation process.

func NewErrors

func NewErrors() *Errors

NewErrors returns a pointer to a Errors object that has been primed and ready to go.

func Validate

func Validate(validators ...Validator) *Errors

Validate takes in n number of Validator objects and will run them and return back a point to a Errors object that will contain any errors.

func (*Errors) Add

func (v *Errors) Add(key string, msg string)

Add will add a new message to the list of errors using the given key. If the key already exists the message will be appended to the array of the existing messages.

func (*Errors) Append

func (v *Errors) Append(ers *Errors)

Append concatenates two Errors objects together. This will modify the first object in place.

func (*Errors) Count

func (v *Errors) Count() int

Count returns the number of errors.

func (*Errors) Error

func (v *Errors) Error() string

Error implements the error interface

func (*Errors) Get

func (v *Errors) Get(key string) []string

Get returns an array of error messages for the given key.

func (*Errors) HasAny

func (v *Errors) HasAny() bool

HasAny returns true/false depending on whether any errors have been tracked.

func (*Errors) String

func (v *Errors) String() string

type Validator

type Validator interface {
	IsValid(errors *Errors)
}

Validator must be implemented in order to pass the validator object into the Validate function.

func ValidatorFunc

func ValidatorFunc(fn func(errors *Errors)) Validator