validation

Documentation

Index

• Constants
• Variables
• type CodecDriver
  • func ParseCodecDriver(v string) (CodecDriver, error)
  • func (d CodecDriver) MarshalText() (text []byte, err error)
  • func (d CodecDriver) String() string
  • func (d *CodecDriver) UnmarshalText(text []byte) error
• type GoPlaygroundValidator
  • func NewGoPlaygroundValidator(opts ...Option) GoPlaygroundValidator
  • func (g GoPlaygroundValidator) Validate(ctx context.Context, v any) error
• type Option
  • func WithCodecDriver(driver CodecDriver) Option
  • func WithRuleFunc(name string, fn ValidateFunc) Option
  • func WithRules(rules ...Rule) Option
• type Rule
  • func NewDateRule() Rule
• type ValidateFunc
• type Validator

Constants

const (
	// JSONDriver is the JSON struct field driver.
	//
	// Uses `json` field tag.
	JSONDriver = CodecDriver(iota) + 1
	// YAMLDriver is the YAML struct field driver.
	//
	// Uses `yaml` field tag.
	YAMLDriver
	// XMLDriver is the XML struct field driver.
	//
	// Uses `xml` field tag.
	XMLDriver
	// TOMLDriver is the TOML struct field driver.
	//
	// Uses `toml` field tag.
	TOMLDriver
	// EnvironmentDriver is the environment struct field driver.
	//
	// Uses `env` field tag.
	EnvironmentDriver
)

Variables

var (
	ErrInvalidCodecDriver = errors.New("validation: codec driver is invalid")
)

Types

type CodecDriver

type CodecDriver uint8

CodecDriver is the codec algorithm to use for struct tag field scanning.

As validators scan struct fields, some of them might define tags for specific codecs (e.g. json). This causes a mismatch between the base and the encoded names and lead to confusion for routine callers.

A CodecDriver defines which tags of a codec mechanism to use for validator operations like error generation.

func ParseCodecDriver

func ParseCodecDriver(v string) (CodecDriver, error)

ParseCodecDriver allocates a new CodecDriver instance based on its string value.

func (CodecDriver) MarshalText

func (d CodecDriver) MarshalText() (text []byte, err error)

func (CodecDriver) String

func (d CodecDriver) String() string

func (*CodecDriver) UnmarshalText

func (d *CodecDriver) UnmarshalText(text []byte) error

type GoPlaygroundValidator

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

GoPlaygroundValidator a concrete implementation of Validator using go-playground/validator package.

func NewGoPlaygroundValidator

func NewGoPlaygroundValidator(opts ...Option) GoPlaygroundValidator

NewGoPlaygroundValidator allocates a new GoPlaygroundValidator instance.

func (GoPlaygroundValidator) Validate

func (g GoPlaygroundValidator) Validate(ctx context.Context, v any) error

Validate validates the given value. Returns error if one or more validations failed.

type Option

type Option func(*options)

Option is a function that modifies the validator behavior.

func WithCodecDriver

func WithCodecDriver(driver CodecDriver) Option

WithCodecDriver sets the codec driver to be used by the validator.

func WithRuleFunc

func WithRuleFunc(name string, fn ValidateFunc) Option

WithRuleFunc adds a custom validation rule routine to the validator.

func WithRules

func WithRules(rules ...Rule) Option

WithRules adds a set of custom validation rules to the validator.

type Rule

type Rule struct {
	// Name is the name of the validation rule.
	Name string
	// ValidateFunc is the function that performs the validation.
	ValidateFunc ValidateFunc
}

Rule represents a validation rule with a name and a validation function.

func NewDateRule

func NewDateRule() Rule

NewDateRule is a custom validation function that checks if the provided value is a valid date string in the format "YYYY-MM-DD".

type ValidateFunc

type ValidateFunc func(fieldName string, value any) bool

ValidateFunc is a function type that defines a custom validation function.

type Validator

type Validator interface {
	// Validate validates the given structure (v).
	Validate(ctx context.Context, v any) error
}

Validator is a utility component used by systems to validate structures.