validator

Documentation

Index

• 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, errMsg string)
  • func (v *Validator) Check(ok bool, key, message string)
  • func (v *Validator) Valid() bool

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 specific value is in a list of permitted values

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 Validator type which contains a map of validation errors

func New

func New() *Validator

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

func (*Validator) AddError

func (v *Validator) AddError(key, errMsg 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.