Documentation
¶
Overview ¶
Package val provides struct field validation utilities.
Index ¶
- func ValidatePassword(password string, errs []string) []string
- type Error
- type FieldError
- type StringValidationContext
- type Validator
- func (v *Validator) Add(fn ValidatorFunction) *Validator
- func (v *Validator) Check(field string) *Validator
- func (v *Validator) Ensure(fn ValidatorFunction) *Validator
- func (v *Validator) Exec(value any) []error
- func (v *Validator) Exists() *Validator
- func (v *Validator) IsEmail() *Validator
- func (v *Validator) IsPassword() *Validator
- func (v *Validator) Matches(strs ...string) *Validator
- func (v *Validator) MinLength(minLength int) *Validator
- type ValidatorFunction
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidatePassword ¶
ValidatePassword validates a password string.
Types ¶
type FieldError ¶
FieldError is a per-field validation error.
func NewFieldError ¶
func NewFieldError(field string, message string) *FieldError
NewFieldError creates a new field error.
func (FieldError) Error ¶
func (f FieldError) Error() string
type StringValidationContext ¶
type StringValidationContext struct {
IsValid bool
// contains filtered or unexported fields
}
StringValidationContext provides fluent string validation.
func CheckString ¶
func CheckString(str string) *StringValidationContext
CheckString creates a string validation context.
func (*StringValidationContext) IsPassword ¶
func (s *StringValidationContext) IsPassword() *StringValidationContext
IsPassword validates password requirements.
func (*StringValidationContext) LengthIsGreaterThanOrEqualTo ¶
func (s *StringValidationContext) LengthIsGreaterThanOrEqualTo(n int) *StringValidationContext
LengthIsGreaterThanOrEqualTo validates minimum length.
type Validator ¶
Validator validates struct fields using registered validation functions.
Example ¶
type User struct {
Name string
Email string
}
v := New()
v.Check("Name").Exists()
v.Check("Email").IsEmail()
// Failing input: blank name and a malformed email.
bad := &User{Name: "", Email: "nope"}
badErrs := v.Exec(bad)
msgs := make([]string, 0, len(badErrs))
for _, err := range badErrs {
msgs = append(msgs, err.Error())
}
// Exec iterates the registered fields in map order, so sort to keep
// the example output stable.
slices.Sort(msgs)
for _, msg := range msgs {
fmt.Println(msg)
}
// Passing input.
good := &User{Name: "Ada", Email: "ada@example.com"}
if errs := v.Exec(good); len(errs) == 0 {
fmt.Println("no validation errors")
}
Output: Field cannot be blank. Field must be an email. no validation errors
func (*Validator) Add ¶
func (v *Validator) Add(fn ValidatorFunction) *Validator
Add registers a validation function for the current field.
func (*Validator) Ensure ¶
func (v *Validator) Ensure(fn ValidatorFunction) *Validator
Ensure adds a custom validation function.
func (*Validator) IsPassword ¶
IsPassword validates minimum password requirements.
type ValidatorFunction ¶
type ValidatorFunction any
ValidatorFunction is a function that validates a value.