validation

package

v0.0.0-...-30e1f3d Latest Latest Go to latest Published: May 3, 2024 License: Apache-2.0 Imports: 7 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

This section is empty.

View Source

var EmptyOrWhitespaceOnlyRE = regexp.MustCompile(`^\s*$`)

EmptyOrWhitespaceOnlyRE is a regex that checks for blank or whitespace only strings

func NewError(violations []*FieldViolation) error

NewError creates new validation error for field violoations.

func NewPlainError(fv *FieldViolation) error

NewPlainError creates new validation error.

type FieldViolation struct {
	Field       string
	Description string
}

FieldViolation represents custom bad request error field violation error option.

func RequiredField(field, fieldName, resourceName string) *FieldViolation

RequiredField verifies that the given field is not empty

type Options struct {
	Target          string
	Request         interface{}
	RequiredDefault bool
	Rules           Rules
}

Options represent configuration option for validator

type Rules map[string][]string

Rules represents rules for fields with name and rules

type Validator struct {
	Opts Options // Opts contains all the options for validator
}

Validator is a validator with options

func New(opts Options) *Validator

New returns a new validator object with provided options

func (v *Validator) Validate() error

Validate validates the validation object raise the error if any