validation

Documentation

Overview

Package validation provides functionality for validation.

Index

• Variables
• func IsAnyValidationError(err error) bool
• func IsFieldValidationError(err error) bool
• func IsValidationError(e error) bool
• func IsValidationErrors(err error) bool
• type FieldValidationError
  • func (ve FieldValidationError) Error() string
• type StandardValidationProvider
  • func (v *StandardValidationProvider) Check(s any) error
• type ValidationError
  • func (ve ValidationError) Error() string
• type ValidationErrors
  • func GetValidationErrors(err error) ValidationErrors
  • func (ve ValidationErrors) Error() string
  • func (ve ValidationErrors) ToMap() map[string]string
  • func (ve ValidationErrors) ToValidationError() ValidationError
• type ValidationProvider
  • func NewStandardValidationProvider() ValidationProvider
• type ValueValidator

Variables

var DefaultValidationProvider = NewStandardValidationProvider()

DefaultValidationProvider is a singleton StandardValidationProvider.

Functions

func IsAnyValidationError

func IsAnyValidationError(err error) bool

IsAnyValidationError returns true if the provided error is a ValidationsErrors or ValidationError.

func IsFieldValidationError

func IsFieldValidationError(err error) bool

IsFieldValidationError returns true if the provided error is a ValidationsErrors or ValidationError.

func IsValidationError

func IsValidationError(e error) bool

func IsValidationErrors

func IsValidationErrors(err error) bool

IsValidationErrors returns true if the provided error is a ValidationsErrors

Types

type FieldValidationError

type FieldValidationError struct {
	Field string
	Err   string
}

FieldValidationError is a validation error for a single field.

func (FieldValidationError) Error

func (ve FieldValidationError) Error() string

Error implements the Error interface.

type StandardValidationProvider

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

StandardValidationProvider uses go playground validation.

func (*StandardValidationProvider) Check

func (v *StandardValidationProvider) Check(s any) error

Check implements the ValidationProvider interface.

type ValidationError

type ValidationError struct {
	Err    string
	Fields map[string]string
}

func (ValidationError) Error

func (ve ValidationError) Error() string

type ValidationErrors

type ValidationErrors []FieldValidationError

ValidationErrors is a collection of validation errors.

func GetValidationErrors

func GetValidationErrors(err error) ValidationErrors

GetValidationErrors returns the error as ValidationErrors if having that type.

func (ValidationErrors) Error

func (ve ValidationErrors) Error() string

Error implements the Error interface.

func (ValidationErrors) ToMap

func (ve ValidationErrors) ToMap() map[string]string

ToMap returns a map with the error string for each field.

func (ValidationErrors) ToValidationError

func (ve ValidationErrors) ToValidationError() ValidationError

type ValidationProvider

type ValidationProvider interface {
	Check(any) error
}

ValidationProvider is a provider for validation services. Any ValidationProvider should return ValidationErrors or nil.

func NewStandardValidationProvider

func NewStandardValidationProvider() ValidationProvider

NewStandardValidationProvider returns an initialized StandardValidationProvider.

type ValueValidator

type ValueValidator interface {
	Validate() error
}

ValueValidator is an interface for value validation functionality. Should return an error when validation fails.