validator

Documentation

Index

• Variables
• func Matches(value string, rx *regexp.Regexp) bool
• func PermittedValue[T comparable](value T, permittedValues ...T) bool
• func Unique[T comparable](values []T) bool
• type Validator
  • func New() *Validator
  • func (v *Validator) AddError(key, message string)
  • func (v *Validator) Check(ok bool, key, message string)
  • func (v *Validator) Valid() bool

Variables

var (
	EmailRX = regexp.MustCompile("^[a-zA-Z0-9.!#$%&'*+\\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$")
)

Regular expression for sanity checking the format of email addresses, taken from https://html.spec.whatwg.org/#valid-e-mail-address

Functions

func Matches

func Matches(value string, rx *regexp.Regexp) bool

Matches returns true if a string value matches a specific regexp pattern.

func PermittedValue

func PermittedValue[T comparable](value T, permittedValues ...T) bool

Generic function which returns true if a specific value is in a list.

func Unique

func Unique[T comparable](values []T) bool

Generic function which returns true if all values in a slice are unique.

Types

type Validator

type Validator struct {
	Errors map[string]string
}

Define a new Validator type which contains a map of validation errors.

func New

func New() *Validator

New is a helper which creates a new Validator instance with an empty errors map.

func (*Validator) AddError

func (v *Validator) AddError(key, message string)

AddError adds an error message to the map (so long as no entry already exists for the given key).

func (*Validator) Check

func (v *Validator) Check(ok bool, key, message string)

Check adds an error message to the map only if a validation check is not 'ok'.

func (*Validator) Valid

func (v *Validator) Valid() bool

Valid returns true if the errors map doesn't contain any entries.