hail

README

Hail

Hail is a golang library for validating data during ingestion.

Documentation

Index

• func Accepted() func(value string) error
• func CountryCodeISO3166Alpha2() func(value string) error
• func CountryCodeISO3166Alpha3() func(value string) error
• func Max[T constraints.Ordered](max T) func(value T) error
• func Min[T constraints.Ordered](min T) func(value T) error
• func PrintableASCII() func(value string) error
• func PrintableUTF8() func(value string) error
• func Regex(pattern string) func(value string) error
• func Size[T ~string | ~[]S, S any](min uint, max uint) func(value T) error
• type ErrASCII
  • func NewErrASCII(value string) ErrASCII
  • func (err ErrASCII) Error() string
• type ErrAccepted
  • func NewErrAccepted(value string) ErrAccepted
  • func (err ErrAccepted) Error() string
• type ErrCountryCode
  • func NewErrCountryCode(value string, format string) ErrCountryCode
  • func (err ErrCountryCode) Error() string
• type ErrMax
  • func NewErrMax[T constraints.Ordered](value T, max T) ErrMax[T]
  • func (err ErrMax[T]) Error() string
• type ErrMin
  • func NewErrMin[T constraints.Ordered](value T, min T) ErrMin[T]
  • func (err ErrMin[T]) Error() string
• type ErrRegex
  • func NewErrRegex(value string, pattern string) ErrRegex
  • func (err ErrRegex) Error() string
• type ErrSize
  • func NewErrSize[T ~string | ~[]S, S any](value T, min, max uint) ErrSize[T, S]
  • func (err ErrSize[T, S]) Error() string
• type ErrUTF8
  • func NewErrUTF8(value string) ErrUTF8
  • func (err ErrUTF8) Error() string
• type RuleSet
  • func Rule[T any](rules ...func(value T) error) (RuleSet[T], error)
  • func (rs RuleSet[T]) Validate(value T) (valid bool, validationErrors []error)

Examples

• Rule

Functions

func Accepted

func Accepted() func(value string) error

The value under validation must be "yes" or "on". This is useful for validating checkbox/boolean html form fields such as "Terms of Service" acceptance.

func CountryCodeISO3166Alpha2

func CountryCodeISO3166Alpha2() func(value string) error

func CountryCodeISO3166Alpha3

func CountryCodeISO3166Alpha3() func(value string) error

func Max

func Max[T constraints.Ordered](max T) func(value T) error

The field under validation must be less than or equal to the maximum value.

func Min

func Min[T constraints.Ordered](min T) func(value T) error

The field under validation must be more than or equal to the minimum value.

func PrintableASCII

func PrintableASCII() func(value string) error

func PrintableUTF8

func PrintableUTF8() func(value string) error

func Regex

func Regex(pattern string) func(value string) error

The field under validation must match the given regular expression.

func Size

func Size[T ~string | ~[]S, S any](min uint, max uint) func(value T) error

Types

type ErrASCII

type ErrASCII struct {
	// contains filtered or unexported fields
}

func NewErrASCII

func NewErrASCII(value string) ErrASCII

func (ErrASCII) Error

func (err ErrASCII) Error() string

type ErrAccepted

type ErrAccepted struct {
	// contains filtered or unexported fields
}

func NewErrAccepted

func NewErrAccepted(value string) ErrAccepted

func (ErrAccepted) Error

func (err ErrAccepted) Error() string

type ErrCountryCode

type ErrCountryCode struct {
	// contains filtered or unexported fields
}

func NewErrCountryCode

func NewErrCountryCode(value string, format string) ErrCountryCode

func (ErrCountryCode) Error

func (err ErrCountryCode) Error() string

type ErrMax

type ErrMax[T constraints.Ordered] struct {
	// contains filtered or unexported fields
}

func NewErrMax

func NewErrMax[T constraints.Ordered](value T, max T) ErrMax[T]

func (ErrMax[T]) Error

func (err ErrMax[T]) Error() string

type ErrMin

type ErrMin[T constraints.Ordered] struct {
	// contains filtered or unexported fields
}

func NewErrMin

func NewErrMin[T constraints.Ordered](value T, min T) ErrMin[T]

func (ErrMin[T]) Error

func (err ErrMin[T]) Error() string

type ErrRegex

type ErrRegex struct {
	// contains filtered or unexported fields
}

func NewErrRegex

func NewErrRegex(value string, pattern string) ErrRegex

func (ErrRegex) Error

func (err ErrRegex) Error() string

type ErrSize

type ErrSize[T ~string | ~[]S, S any] struct {
	// contains filtered or unexported fields
}

func NewErrSize

func NewErrSize[T ~string | ~[]S, S any](value T, min, max uint) ErrSize[T, S]

func (ErrSize[T, S]) Error

func (err ErrSize[T, S]) Error() string

type ErrUTF8

type ErrUTF8 struct {
	// contains filtered or unexported fields
}

func NewErrUTF8

func NewErrUTF8(value string) ErrUTF8

func (ErrUTF8) Error

func (err ErrUTF8) Error() string

type RuleSet

type RuleSet[T any] []func(value T) error

func Rule

func Rule[T any](rules ...func(value T) error) (RuleSet[T], error)

Example

package main

import (
	"fmt"

	"gitlab.com/JankTech/hail"
)

func main() {
	v := 123
	r, err := hail.Rule(hail.Min(130), hail.Max(110))
	if err != nil {
		panic(err)
	}

	ok, errs := r.Validate(v)
	if !ok {
		for _, err = range errs {
			fmt.Println(err.Error())
		}
	}

}

Output:

value 123 is less than min 130
value 123 is more than max 110

func (RuleSet[T]) Validate

func (rs RuleSet[T]) Validate(value T) (valid bool, validationErrors []error)