README
¶
validator
A lightweight model validator written in Go.
Features
- Supports multiple language.
quickstart
package main
import (
"fmt"
v "github.com/go-the-way/validator"
)
func main() {
result := v.New(&struct {
int `validate:"min(10,fail)"`
}{}).Validate()
fmt.Println(result.Passed)
fmt.Println(result.Messages())
}
Custom validation implementation
package main
import (
"fmt"
v "github.com/go-the-way/validator"
"reflect"
)
func main() {
v.Custom("mycustom", func(value reflect.Value) (bool, string) { return false, "mycustom validation." })
vv := v.New(&struct {
Name string `validate:"custom(mycustom)"`
}{}).Validate()
fmt.Println(vv.Passed)
fmt.Println(vv.Messages())
}
Validators
| Name | Support | Example | Description |
|---|---|---|---|
| Min | ([])(*)uint{8,64}, ([])(*)int{8,64}, ([])(*)float{32,64} |
validate:"min(N,invalid)" | Every value must be >= N |
| Max | ([])(*)uint{8,64}, ([])(*)int{8,64}, ([])(*)float{32,64} |
validate:"max(N,invalid)" | Every value must be <= N |
| Length | (*)string, (*)Array[(*)string], (*)Slice[(*)string] |
validate:"length(N,invalid)" | (*)string: Value's Len must be == N(*)Array[(*)string] or (*)Slice[(*)string]: Every Value's Len must be == N |
| ArrLength | (*)Array[(*)Any], (*)Slice[(*)Any] |
validate:"arr_length(N,invalid)" | (*)Array[(*)Any] or (*)Slice[(*)Any]: Array or Slice's Len must be == N |
| MinLength | (*)string, (*)Array[(*)string], (*)Slice[(*)string] |
validate:"minlength(N,invalid)" | (*)string: Value's Len must be >= N(*)Array[(*)string] or (*)Slice[(*)string]: Every Value's Len must be >= N |
| ArrMinLength | (*)Array[(*)Any], (*)Slice[(*)Any] |
validate:"arr_minlength(N,invalid)" | (*)Array[(*)Any] or (*)Slice[(*)Any]: Array or Slice's Len must be >= N |
| MaxLength | (*)string, (*)Array[(*)string], (*)Slice[(*)string] |
validate:"maxlength(N,invalid)" | (*)string: Value's Len must be <= N(*)Array[(*)string] or (*)Slice[(*)string]: Every Value's Len must be <= N |
| ArrMaxLength | (*)Array[(*)Any], (*)Slice[(*)Any] |
validate:"arr_maxlength(N,invalid)" | (*)Array[(*)Any] or (*)Slice[(*)Any]: Array or Slice's Len must be <= N |
| Enum | ([])(*)uint{8,64}, ([])(*)int{8,64}, ([])(*)float{32,64}, ([])(*)string |
validate:"enum(O,invalid)" | Every value must be one of O |
| Regex | ([])(*)string |
validate:"regex(RE,invalid)" | Every value must be match RE |
| Valid | *struct{} |
validate:"valid(T,invalid)" | Value must be not nil |
| Custom | any |
validate:"custom(CUSTOM)" | CUSTOM validation |
Documentation
¶
Overview ¶
Package validator is a lightweight model validator written in Go.
::quickstart::
package main
import (
"fmt"
v "github.com/go-the-way/validator"
)
func main() {
result := v.New(&struct {
int `validate:"min(10,fail)"`
}{}).Validate()
fmt.Println(result.Passed)
fmt.Println(result.Messages())
}
Index ¶
- func Custom(name string, vF func(value reflect.Value) (bool, string))
- type Item
- type Result
- type ResultItem
- type VFunc
- func ArrLengthFunc(str string) VFunc
- func ArrMaxLengthFunc(str string) VFunc
- func ArrMinLengthFunc(str string) VFunc
- func EnumFunc(str string) VFunc
- func LengthFunc(str string) VFunc
- func MaxFunc(str string) VFunc
- func MaxLengthFunc(str string) VFunc
- func MinFunc(str string) VFunc
- func MinLengthFunc(str string) VFunc
- func RegexFunc(str string) VFunc
- func ValidFunc(str string) VFunc
- type Validator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Item ¶
type Item struct {
Min string `alias:"min"` // Min for min value
Max string `alias:"max"` // Max for max value
MinLength string `alias:"minlength"` // MinLength for min length
ArrMinLength string `alias:"arr_minlength"` // ArrMinLength for array min length
MaxLength string `alias:"maxlength"` // MaxLength for max length
ArrMaxLength string `alias:"arr_maxlength"` // ArrMaxLength for array max length
Length string `alias:"length"` // Length for length
ArrLength string `alias:"arr_length"` // ArrLength for array length
Enum string `alias:"enum"` // Enum for enum values
Regex string `alias:"regex"` // Regex for regex pattern
Msg string `alias:"msg"` // Msg for message
Valid string `alias:"valid"` // Valid for valid
Custom string `alias:"custom"` // Custom for custom validator
}
Item struct
type Result ¶
type Result struct {
StructPtr interface{}
Passed bool
Items []*ResultItem
// contains filtered or unexported fields
}
Result struct
type ResultItem ¶
type ResultItem struct {
Field *reflect.StructField
Passed bool
Message string
}
ResultItem struct
type VFunc ¶
VFunc interface
func ArrMaxLengthFunc ¶ added in v1.0.2
ArrMaxLengthFunc method
func ArrMinLengthFunc ¶ added in v1.0.2
ArrMinLengthFunc method
Source Files
Click to show internal directories.
Click to hide internal directories.