README
¶
#vld
Validator engine for Golang. Validate struct fields or write custom validations as functions. Chain them together and make your code cleaner and easier to reason.2
#Installation
Make sure that Go is installed on your computer. Type the following command in your terminal:
go get github.com/mkasner/vld
#Example Example struct we want to validate with the following rules:
- Field Kind is required and must not be longer then 10 characters
- Feld year is required and must not be less than 1900 and greater than 3000
type Wine struct {
Kind string
Year int
}
The ususal way would be something like this
func (w *Wine) Validate() error {
if w.Kind == "" {
return errors.New("Wine.Kind required")
}
if len(w.Kind) > 10 {
return errors.New("Wine.Kind must be smaller than 10 characters")
}
if w.Year == 0 {
return errors.New("Wine.Year is required")
}
if w.Year < 1900 {
return errors.New("Wine.Year must be greater than 1900")
}
if w.Year > 3000 {
return errors.New("Wine.Year must be smaller than 3000")
}
return nil
}
func isValid(w *Wine) bool {
if err := w.Validate(); err != nil {
return true
}
return false
}
Or with the help of vld utility
//go:generate vld -type=Wine
package cellar
type Wine struct {
Kind string `vld:"req,maxlen=10"`
Year int `vld:"req,maxint=3000,minint=1900"`
}
func isValid(w Wine) bool {
if err := vld.New().Add(w).Validate(); err != nil {
return true
}
return false
}
It generates struct validator for you, so you can just call validate method on struct and get results. #Thanks
- github.com/asaskevich/govalidator - lots of documented and tested validations
- https://godoc.org/golang.org/x/tools/cmd/stringer - intro into AST package and code generation
Documentation
¶
Overview ¶
Package for declaring and executing validations which can be techninal validations, bussiness validations, struct validations
Index ¶
- type Context
- type DefaultValidation
- type Validation
- type ValidationFunc
- func MaxFloat32(limit, value float32, name string) ValidationFunc
- func MaxFloat64(limit, value float32, name string) ValidationFunc
- func MaxInt(limit, value int, name string) ValidationFunc
- func MaxInt64(limit, value int64, name string) ValidationFunc
- func MaxLength(length int, value, name string) ValidationFunc
- func Message(f ValidationFunc, message string) ValidationFunc
- func MinFloat32(limit, value float32, name string) ValidationFunc
- func MinFloat64(limit, value float32, name string) ValidationFunc
- func MinInt(limit, value int, name string) ValidationFunc
- func MinInt64(limit, value int64, name string) ValidationFunc
- func MinLength(length int, value, name string) ValidationFunc
- func Required(value interface{}, name string) ValidationFunc
- type Validator
- type VldErrors
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Context ¶
type Context struct {
Err error
}
Passes data between validations. Used for error passing at the moment.
type DefaultValidation ¶
type DefaultValidation struct {
}
Default struct which you can embed into your struct that implements ValidateOverride method. In that way you only must implement Validate method
func (DefaultValidation) ValidateOverride ¶
func (f DefaultValidation) ValidateOverride(ctx Context) Context
type Validation ¶
Every type which wants to act as validation must implement this interface
type ValidationFunc ¶
type ValidationFunc func() error
Type that holds validation func which implements Validation interface
func Message ¶
func Message(f ValidationFunc, message string) ValidationFunc
func (ValidationFunc) Validate ¶
func (f ValidationFunc) Validate(ctx Context) Context
func (ValidationFunc) ValidateOverride ¶
func (f ValidationFunc) ValidateOverride(ctx Context) Context
type Validator ¶
type Validator struct {
// contains filtered or unexported fields
}
Holds and runs validations
func (*Validator) Add ¶
func (t *Validator) Add(v Validation) *Validator
Adds validation to validator
func (*Validator) ValidateAll ¶
Validates all validations and collects errors
func (*Validator) Validations ¶
func (t *Validator) Validations(v Validation) []Validation
Returns validations on this validator
Source Files
Directories