validation

Documentation

Overview

Package validation implements a functional API for consistent struct level validation.

Index

• func HasErrorCode(err error, code ErrorCode) bool
• func JoinErrors[T error](b *strings.Builder, errs []T, indent string)
• type ErrorCode
• type Predicate
• type PropertyError
  • func NewPropertyError(propertyName string, propertyValue interface{}, errs []error) *PropertyError
  • func (e *PropertyError) Error() string
  • func (e *PropertyError) PrependPropertyName(name string)
• type PropertyGetter
  • func GetSelf[S any]() PropertyGetter[S, S]
• type PropertyRules
  • func RulesFor[T, S any](getter PropertyGetter[T, S]) PropertyRules[T, S]
  • func (r PropertyRules[T, S]) Include(rules ...Validator[T]) PropertyRules[T, S]
  • func (r PropertyRules[T, S]) Rules(rules ...Rule[T]) PropertyRules[T, S]
  • func (r PropertyRules[T, S]) StopOnError() PropertyRules[T, S]
  • func (r PropertyRules[T, S]) Validate(st S) []error
  • func (r PropertyRules[T, S]) When(predicates ...Predicate[S]) PropertyRules[T, S]
  • func (r PropertyRules[T, S]) WithName(name string) PropertyRules[T, S]
• type Rule
  • func EqualTo[T comparable](compared T) Rule[T]
  • func GreaterThan[T constraints.Ordered](n T) Rule[T]
  • func GreaterThanOrEqualTo[T constraints.Ordered](n T) Rule[T]
  • func LessThan[T constraints.Ordered](n T) Rule[T]
  • func LessThanOrEqualTo[T constraints.Ordered](n T) Rule[T]
  • func NotEqualTo[T comparable](compared T) Rule[T]
  • func Required[T any]() Rule[T]
• type RuleError
  • func (r RuleError) AddCode(code ErrorCode) RuleError
  • func (r RuleError) Error() string
• type RuleSet
  • func NewRuleSet[T any](rules ...Rule[T]) RuleSet[T]
  • func StringIsDNSSubdomain() RuleSet[string]
  • func (r RuleSet[T]) Validate(v T) error
  • func (r RuleSet[T]) WithErrorCode(code ErrorCode) RuleSet[T]
• type Rules
• type SingleRule
  • func NewSingleRule[T any](validate func(v T) error) SingleRule[T]
  • func StringDescription() SingleRule[string]
  • func StringLength(min, max int) SingleRule[string]
  • func (r SingleRule[T]) Validate(v T) error
  • func (r SingleRule[T]) WithErrorCode(code ErrorCode) SingleRule[T]
• type Validator
  • func New[S any](rules ...Rules[S]) Validator[S]
  • func (v Validator[S]) Validate(st S) []error

Functions

func HasErrorCode

func HasErrorCode(err error, code ErrorCode) bool

func JoinErrors

func JoinErrors[T error](b *strings.Builder, errs []T, indent string)

Types

type ErrorCode

type ErrorCode = string

const (
	ErrorCodeRequired             ErrorCode = "required"
	ErrorCodeEqualTo              ErrorCode = "equal_to"
	ErrorCodeNotEqualTo           ErrorCode = "not_equal_to"
	ErrorCodeGreaterThan          ErrorCode = "greater_than"
	ErrorCodeGreaterThanOrEqualTo ErrorCode = "greater_than_or_equal_to"
	ErrorCodeLessThan             ErrorCode = "less_than"
	ErrorCodeLessThanOrEqualTo    ErrorCode = "less_than_or_equal_to"
	ErrorCodeStringLength         ErrorCode = "string_length"
	ErrorCodeStringDescription    ErrorCode = "string_description"
	ErrorCodeStringIsDNSSubdomain ErrorCode = "string_is_dns_subdomain"
)

type Predicate

type Predicate[S any] func(S) bool

type PropertyError

type PropertyError struct {
	PropertyName  string      `json:"propertyName"`
	PropertyValue string      `json:"propertyValue"`
	Errors        []RuleError `json:"errors"`
}

func NewPropertyError

func NewPropertyError(propertyName string, propertyValue interface{}, errs []error) *PropertyError

func (*PropertyError) Error

func (e *PropertyError) Error() string

func (*PropertyError) PrependPropertyName

func (e *PropertyError) PrependPropertyName(name string)

type PropertyGetter

type PropertyGetter[T, S any] func(S) T

func GetSelf

func GetSelf[S any]() PropertyGetter[S, S]

GetSelf is a convenience method for extracting 'self' property of a validated value.

type PropertyRules

type PropertyRules[T, S any] struct {
	// contains filtered or unexported fields
}

PropertyRules is responsible for validating a single property.

func RulesFor

func RulesFor[T, S any](getter PropertyGetter[T, S]) PropertyRules[T, S]

RulesFor creates a typed PropertyRules instance for the property which access is defined through getter function.

func (PropertyRules[T, S]) Include

func (r PropertyRules[T, S]) Include(rules ...Validator[T]) PropertyRules[T, S]

func (PropertyRules[T, S]) Rules

func (r PropertyRules[T, S]) Rules(rules ...Rule[T]) PropertyRules[T, S]

func (PropertyRules[T, S]) StopOnError

func (r PropertyRules[T, S]) StopOnError() PropertyRules[T, S]

func (PropertyRules[T, S]) Validate

func (r PropertyRules[T, S]) Validate(st S) []error

func (PropertyRules[T, S]) When

func (r PropertyRules[T, S]) When(predicates ...Predicate[S]) PropertyRules[T, S]

func (PropertyRules[T, S]) WithName

func (r PropertyRules[T, S]) WithName(name string) PropertyRules[T, S]

type Rule

type Rule[T any] interface {
	Validate(v T) error
}

Rule is the interface for all validation rules.

func EqualTo

func EqualTo[T comparable](compared T) Rule[T]

func GreaterThan

func GreaterThan[T constraints.Ordered](n T) Rule[T]

func GreaterThanOrEqualTo

func GreaterThanOrEqualTo[T constraints.Ordered](n T) Rule[T]

func LessThan

func LessThan[T constraints.Ordered](n T) Rule[T]

func LessThanOrEqualTo

func LessThanOrEqualTo[T constraints.Ordered](n T) Rule[T]

func NotEqualTo

func NotEqualTo[T comparable](compared T) Rule[T]

func Required

func Required[T any]() Rule[T]

type RuleError

type RuleError struct {
	Message string    `json:"error"`
	Code    ErrorCode `json:"code,omitempty"`
}

func (RuleError) AddCode

func (r RuleError) AddCode(code ErrorCode) RuleError

func (RuleError) Error

func (r RuleError) Error() string

type RuleSet

type RuleSet[T any] struct {
	// contains filtered or unexported fields
}

RuleSet allows defining Rule which aggregates multiple sub-rules.

func NewRuleSet

func NewRuleSet[T any](rules ...Rule[T]) RuleSet[T]

func StringIsDNSSubdomain

func StringIsDNSSubdomain() RuleSet[string]

func (RuleSet[T]) Validate

func (r RuleSet[T]) Validate(v T) error

func (RuleSet[T]) WithErrorCode

func (r RuleSet[T]) WithErrorCode(code ErrorCode) RuleSet[T]

type Rules

type Rules[S any] interface {
	Validate(v S) []error
}

type SingleRule

type SingleRule[T any] struct {
	// contains filtered or unexported fields
}

func NewSingleRule

func NewSingleRule[T any](validate func(v T) error) SingleRule[T]

func StringDescription

func StringDescription() SingleRule[string]

func StringLength

func StringLength(min, max int) SingleRule[string]

func (SingleRule[T]) Validate

func (r SingleRule[T]) Validate(v T) error

func (SingleRule[T]) WithErrorCode

func (r SingleRule[T]) WithErrorCode(code ErrorCode) SingleRule[T]

type Validator

type Validator[S any] struct {
	// contains filtered or unexported fields
}

func New

func New[S any](rules ...Rules[S]) Validator[S]

func (Validator[S]) Validate

func (v Validator[S]) Validate(st S) []error