validators

Documentation

Overview

Package validators contains the validation functions for the application. these specificially relate to the prompts/questions asked to the user and validating the user input.

Index

• func NotZero[T Validatable](v T) error
• type Validatable
• type Validate
• type ValidateMatch
• type Validator
  • func Combine[T any](validators ...Validator[T]) Validator[T]
  • func GetValidatorFuncs[T Validatable](v Validate) []Validator[T]
  • func Match[T Validatable](re string, msg string) Validator[T]
  • func MaxLength[T any](m int) Validator[T]
  • func MinLength[T Validatable](m int) Validator[T]

Functions

func NotZero

func NotZero[T Validatable](v T) error

NotZero validates that the value is not zero. It returns an error if the value is zero.

Types

type Validatable

type Validatable interface {
	string | []string
}

type Validate

type Validate struct {
	Required  bool          `yaml:"required"`
	MinLength int           `yaml:"min"`
	MaxLength int           `yaml:"max"`
	Match     ValidateMatch `yaml:"match"`
}

Validate is a struct the holds the configuration for a validator.

type ValidateMatch

type ValidateMatch struct {
	Regex   string `yaml:"regex"`
	Message string `yaml:"message"`
}

type Validator

type Validator[T any] func(v T) error

func Combine

func Combine[T any](validators ...Validator[T]) Validator[T]

func GetValidatorFuncs

func GetValidatorFuncs[T Validatable](v Validate) []Validator[T]

GetValidatorFuncs converts a Validate struct into a slice of validator functions.

func Match

func Match[T Validatable](re string, msg string) Validator[T]

func MaxLength

func MaxLength[T any](m int) Validator[T]

MaxLength validates that the value is at most m long.

func MinLength

func MinLength[T Validatable](m int) Validator[T]

MinLength validates that the value is at least m long.