validate

package

v0.7.2 Latest Latest Go to latest Published: May 21, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package validate provides a generic implementation for any object type using validation rules

This section is empty.

View Source

var ErrConfig = errors.New("cannot validate, invalid configuration")

ErrConfig return this error if the configuration file is invalid

View Source

var ErrFailedRule = errors.New("Failed Rule")

ErrFailedRule return this error if an object fails a validation rule

func ConfigByField[T any](configReader io.Reader, fieldname string) (T, error)

ConfigByField get the config field name after decoding

func DenyFunc[S ~[]E, E any](target S, check func(E) error) error

DenyFunc generic execution of a check function over a slice of objects

func NewFailedRuleError(rule string, id string) error

NewFailedRuleError convenience function for error wrapping

type Validator[ObjectT any, ConfigT any] struct {
	// contains filtered or unexported fields
}

Validator generic validation runner

func NewValidator[ObjectT any, ConfigT any]() Validator[ObjectT, ConfigT]

NewValidator used to create specific implementations of a validator

func (v Validator[ObjectT, ConfigT]) ReadConfigAndValidate(objects []ObjectT, configReader io.Reader, field string) error

ReadConfigAndValidate validate after decoding the configuration object

func (v Validator[ObjectT, ConfigT]) Validate(objects []ObjectT, config ConfigT) error

Validate run validation rules on a slice of objects

func (v Validator[ObjectT, ConfigT]) WithAllowRules(rules ...func(ObjectT, ConfigT) bool) Validator[ObjectT, ConfigT]

WithAllowRules define the allow rules which will skip validation

func (v Validator[ObjectT, ConfigT]) WithValidationRules(rules ...func([]ObjectT, ConfigT) error) Validator[ObjectT, ConfigT]

WithValidationRules define the fail validation rules, all must pass