vldz

Documentation

Overview

Package vldz provides various utilities for validating data.

Index

• func MustRegisterValidator(tag string, validator validator.Func)
• func MustValidateStruct(v any)
• func RegexpValidatorFactory(regexp *regexp.Regexp) validator.Func
• func ValidateStruct(v any) error
• type ValidationError
  • func NewValidationError(err error) *ValidationError
  • func (e *ValidationError) Error() string
  • func (e *ValidationError) MaybeGetFieldsSummary() map[string]any
  • func (e *ValidationError) Unwrap() error

Functions

func MustRegisterValidator

func MustRegisterValidator(tag string, validator validator.Func)

MustRegisterValidator registers a validator.

func MustValidateStruct

func MustValidateStruct(v any)

MustValidateStruct is like ValidateStruct but panics on error.

func RegexpValidatorFactory

func RegexpValidatorFactory(regexp *regexp.Regexp) validator.Func

RegexpValidatorFactory creates a validator that matches a string against the given regexp.

func ValidateStruct

func ValidateStruct(v any) error

ValidateStruct validates a struct.

Types

type ValidationError

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

ValidationError describes a validation error.

func NewValidationError

func NewValidationError(err error) *ValidationError

NewValidationError initializes a new validation error.

func (*ValidationError) Error

func (e *ValidationError) Error() string

Error implements the error interface.

func (*ValidationError) MaybeGetFieldsSummary

func (e *ValidationError) MaybeGetFieldsSummary() map[string]any

MaybeGetFieldsSummary returns the fields summary if available.

func (*ValidationError) Unwrap

func (e *ValidationError) Unwrap() error

Unwrap implements the errorz.UnwrapSingle interface.