validation

May 31, 2024

Changes in this version

+ type CascadeMode uint

+ const CascadeModeContinue

+ const CascadeModeStop

type PropertyError

+ func (e *PropertyError) Equal(cmp *PropertyError) bool

type PropertyErrors

+ func (e PropertyErrors) Aggregate() PropertyErrors

+ func (e PropertyErrors) Sort() PropertyErrors

+ type PropertyPlan struct

+ Examples []string

+ IsHidden bool

+ IsOptional bool

+ Package string

+ Path string

+ Rules []RulePlan

+ Type string

+ func Plan[S any](v Validator[S]) []PropertyPlan

type PropertyRules

+ func (r PropertyRules[T, S]) Cascade(mode CascadeMode) PropertyRules[T, S]

+ func (r PropertyRules[T, S]) WithExamples(examples ...string) PropertyRules[T, S]

type PropertyRulesForMap

+ func (r PropertyRulesForMap[M, K, V, S]) Cascade(mode CascadeMode) PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) WithExamples(examples ...string) PropertyRulesForMap[M, K, V, S]

type PropertyRulesForSlice

+ func (r PropertyRulesForSlice[T, S]) Cascade(mode CascadeMode) PropertyRulesForSlice[T, S]

+ func (r PropertyRulesForSlice[T, S]) WithExamples(examples ...string) PropertyRulesForSlice[T, S]

+ type RulePlan struct

+ Conditions []string

+ Description string

+ Details string

+ ErrorCode ErrorCode

type SingleRule

+ func (r SingleRule[T]) WithDescription(description string) SingleRule[T]

+ type WhenOptions struct

+ func WhenDescription(format string, a ...interface{}) WhenOptions

Apr 9, 2024

Changes in this version

type PropertyError

+ IsSliceElementError bool

Apr 5, 2024

Changes in this version

+ func MapElementName(mapName, key any) string

+ type MapItem struct

+ Key K

+ Value V

type PropertyError

+ IsKeyError bool

+ type PropertyRulesForMap struct

+ func ForMap[M ~map[K]V, K comparable, V, S any](getter PropertyGetter[M, S]) PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) IncludeForItems(rules ...Validator[MapItem[K, V]]) PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) IncludeForKeys(rules ...Validator[K]) PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) IncludeForValues(rules ...Validator[V]) PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) Rules(rules ...Rule[M]) PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) RulesForItems(rules ...Rule[MapItem[K, V]]) PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) RulesForKeys(rules ...Rule[K]) PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) RulesForValues(rules ...Rule[V]) PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) StopOnError() PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) Validate(st S) PropertyErrors

+ func (r PropertyRulesForMap[M, K, V, S]) When(predicate Predicate[S]) PropertyRulesForMap[M, K, V, S]

+ func (r PropertyRulesForMap[M, K, V, S]) WithName(name string) PropertyRulesForMap[M, K, V, S]

+ type PropertyRulesForSlice struct

+ func ForSlice[T, S any](getter PropertyGetter[[]T, S]) PropertyRulesForSlice[T, S]

+ func (r PropertyRulesForSlice[T, S]) IncludeForEach(rules ...Validator[T]) PropertyRulesForSlice[T, S]

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

+ func (r PropertyRulesForSlice[T, S]) RulesForEach(rules ...Rule[T]) PropertyRulesForSlice[T, S]

+ func (r PropertyRulesForSlice[T, S]) StopOnError() PropertyRulesForSlice[T, S]

+ func (r PropertyRulesForSlice[T, S]) Validate(st S) PropertyErrors

+ func (r PropertyRulesForSlice[T, S]) When(predicate Predicate[S]) PropertyRulesForSlice[T, S]

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

type SingleRule

+ func (r SingleRule[T]) WithMessage(format string, a ...any) SingleRule[T]

Feb 28, 2024

Changes in this version

type ErrorCode

+ const ErrorCodeDurationPrecision

type SingleRule

+ func DurationPrecision(precision time.Duration) SingleRule[time.Duration]

Dec 21, 2023

Changes in this version

+ const ErrorCodeSeparator

+ func HasErrorCode(err error, code ErrorCode) bool

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

+ func SliceElementName(sliceName string, index int) string

+ type ErrorCode = string

+ const ErrorCodeEqualTo

+ const ErrorCodeForbidden

+ const ErrorCodeGreaterThan

+ const ErrorCodeGreaterThanOrEqualTo

+ const ErrorCodeLessThan

+ const ErrorCodeLessThanOrEqualTo

+ const ErrorCodeMapLength

+ const ErrorCodeMapMaxLength

+ const ErrorCodeMapMinLength

+ const ErrorCodeMutuallyExclusive

+ const ErrorCodeNotEqualTo

+ const ErrorCodeOneOf

+ const ErrorCodeRequired

+ const ErrorCodeSliceLength

+ const ErrorCodeSliceMaxLength

+ const ErrorCodeSliceMinLength

+ const ErrorCodeSliceUnique

+ const ErrorCodeStringASCII

+ const ErrorCodeStringContains

+ const ErrorCodeStringDenyRegexp

+ const ErrorCodeStringDescription

+ const ErrorCodeStringIsDNSSubdomain

+ const ErrorCodeStringJSON

+ const ErrorCodeStringLength

+ const ErrorCodeStringMatchRegexp

+ const ErrorCodeStringMaxLength

+ const ErrorCodeStringMinLength

+ const ErrorCodeStringNotEmpty

+ const ErrorCodeStringStartsWith

+ const ErrorCodeStringURL

+ const ErrorCodeStringUUID

+ const ErrorCodeTransform

+ const ErrorCodeURL

+ type HashFunction func(v V) H

+ func SelfHashFunc[H comparable]() HashFunction[H, H]

+ type Predicate func(S) bool

+ type PropertyError struct

+ Errors []*RuleError

+ PropertyName string

+ PropertyValue string

+ func NewPropertyError(propertyName string, propertyValue interface{}, errs ...error) *PropertyError

+ func (e *PropertyError) Error() string

+ func (e *PropertyError) HideValue() *PropertyError

+ func (e *PropertyError) PrependPropertyName(name string) *PropertyError

+ type PropertyErrors []*PropertyError

+ func (e PropertyErrors) Error() string

+ func (e PropertyErrors) HideValue() PropertyErrors

+ type PropertyGetter func(S) T

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

+ type PropertyRules struct

+ func ForPointer[T, S any](getter PropertyGetter[*T, S]) PropertyRules[T, S]

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

+ func Transform[T, N, S any](getter PropertyGetter[T, S], transform Transformer[T, N]) PropertyRules[N, S]

+ func (r PropertyRules[T, S]) HideValue() PropertyRules[T, S]

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

+ func (r PropertyRules[T, S]) OmitEmpty() PropertyRules[T, S]

+ func (r PropertyRules[T, S]) Required() 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) PropertyErrors

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

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

+ type PropertyRulesForEach struct

+ func ForEach[T, S any](getter PropertyGetter[[]T, S]) PropertyRulesForEach[T, S]

+ func (r PropertyRulesForEach[T, S]) IncludeForEach(rules ...Validator[T]) PropertyRulesForEach[T, S]

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

+ func (r PropertyRulesForEach[T, S]) RulesForEach(rules ...Rule[T]) PropertyRulesForEach[T, S]

+ func (r PropertyRulesForEach[T, S]) StopOnError() PropertyRulesForEach[T, S]

+ func (r PropertyRulesForEach[T, S]) Validate(st S) PropertyErrors

+ func (r PropertyRulesForEach[T, S]) When(predicate Predicate[S]) PropertyRulesForEach[T, S]

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

+ type Rule interface

+ Validate func(v T) error

+ type RuleError struct

+ Code ErrorCode

+ Message string

+ func NewRequiredError() *RuleError

+ func NewRuleError(message string, codes ...ErrorCode) *RuleError

+ func (r *RuleError) AddCode(code ErrorCode) *RuleError

+ func (r *RuleError) Error() string

+ func (r *RuleError) HideValue(stringValue string) *RuleError

+ type RuleSet struct

+ 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]) WithDetails(format string, a ...any) RuleSet[T]

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

+ type SingleRule struct

+ func EqualTo[T comparable](compared T) SingleRule[T]

+ func Forbidden[T any]() SingleRule[T]

+ func GreaterThanOrEqualTo[T constraints.Ordered](n T) SingleRule[T]

+ func GreaterThan[T constraints.Ordered](n T) SingleRule[T]

+ func LessThanOrEqualTo[T constraints.Ordered](n T) SingleRule[T]

+ func LessThan[T constraints.Ordered](n T) SingleRule[T]

+ func MapLength[M ~map[K]V, K comparable, V any](min, max int) SingleRule[M]

+ func MapMaxLength[M ~map[K]V, K comparable, V any](max int) SingleRule[M]

+ func MapMinLength[M ~map[K]V, K comparable, V any](min int) SingleRule[M]

+ func MutuallyExclusive[S any](required bool, getters map[string]func(s S) any) SingleRule[S]

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

+ func NotEqualTo[T comparable](compared T) SingleRule[T]

+ func OneOf[T comparable](values ...T) SingleRule[T]

+ func Required[T any]() SingleRule[T]

+ func SliceLength[S ~[]E, E any](min, max int) SingleRule[S]

+ func SliceMaxLength[S ~[]E, E any](max int) SingleRule[S]

+ func SliceMinLength[S ~[]E, E any](min int) SingleRule[S]

+ func SliceUnique[S []V, V any, H comparable](hashFunc HashFunction[V, H], constraints ...string) SingleRule[S]

+ func StringASCII() SingleRule[string]

+ func StringContains(substrings ...string) SingleRule[string]

+ func StringDenyRegexp(re *regexp.Regexp, examples ...string) SingleRule[string]

+ func StringDescription() SingleRule[string]

+ func StringJSON() SingleRule[string]

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

+ func StringMatchRegexp(re *regexp.Regexp, examples ...string) SingleRule[string]

+ func StringMaxLength(max int) SingleRule[string]

+ func StringMinLength(min int) SingleRule[string]

+ func StringNotEmpty() SingleRule[string]

+ func StringStartsWith(prefixes ...string) SingleRule[string]

+ func StringURL() SingleRule[string]

+ func StringUUID() SingleRule[string]

+ func URL() SingleRule[*url.URL]

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

+ func (r SingleRule[T]) WithDetails(format string, a ...any) SingleRule[T]

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

+ type Transformer func(T) (N, error)

+ type Validator struct

+ func New[S any](props ...propertyRulesI[S]) Validator[S]

+ func (v Validator[S]) Validate(st S) *ValidatorError

+ func (v Validator[S]) When(predicates ...Predicate[S]) Validator[S]

+ func (v Validator[S]) WithName(name string) Validator[S]

+ type ValidatorError struct

+ Errors PropertyErrors

+ Name string

+ func NewValidatorError(errs PropertyErrors) *ValidatorError

+ func (e *ValidatorError) Error() string

+ func (e *ValidatorError) WithName(name string) *ValidatorError