Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

validate

package module

Go to main page

Versions in this module

v2

v2.0.1

Jun 9, 2026

Changes in this version

+ func CheckErr(structPtr any, scene ...string) error

+ type FieldCtx interface

+ Arg func(i int) (any, bool)

+ Args func() []any

+ FieldName func() string

+ Raw func() reflect.Value

+ Value func() reflect.Value

+ type ValidResult struct

+ Errors Errors

+ func Check(structPtr any, scene ...string) *ValidResult

+ func (r *ValidResult) BindSafeData(ptr any) error

+ func (r *ValidResult) BindStruct(ptr any) error

+ func (r *ValidResult) Err() error

+ func (r *ValidResult) Fail() bool

+ func (r *ValidResult) Filtered(key string) any

+ func (r *ValidResult) FilteredData() M

+ func (r *ValidResult) IsOK() bool

+ func (r *ValidResult) Safe(key string) (val any, ok bool)

+ func (r *ValidResult) SafeData() M

+ func (r *ValidResult) SafeVal(key string) any

type Validation

+ func (v *Validation) ValidateR(scene ...string) *ValidResult

v2.0.0

Jun 6, 2026

Changes in this version

+ const Base64

+ const DNSName

+ const Email

+ const Float

+ const FullURL

+ const FullWidth

+ const HalfWidth

+ const Int

+ const Latitude

+ const Longitude

+ const RGBColor

+ const RuleDefault

+ const RuleOptional

+ const RuleRegexp

+ const RuleRequired

+ const RuleSafe

+ const RuleSafe1

+ const URLIP

+ const URLPath

+ const URLPort

+ const URLSchema

+ const URLSubdomain

+ const URLUsername

+ const UUID

+ const UUID3

+ const UUID4

+ const UUID5

+ const UnixPath

+ const WinPath

+ var ActiveURLTimeout = 5 * time.Second

+ var DefaultFieldName = "input"

+ var ErrConvertFail = errors.New("convert value is failure")

+ var ErrEmptyData = errors.New("please input data use for validate")

+ var ErrInvalidData = errors.New("invalid input data")

+ var ErrNoField = errors.New("field not exist in the source data")

+ var ErrUnaddressableField = errors.New("cannot set value as it was not passed-by-reference")

+ var Marshal MarshalFunc = json.Marshal

+ var NilValue = reflect.Zero(reflect.TypeOf((*any)(nil)).Elem())

+ var Unmarshal UnmarshalFunc = json.Unmarshal

+ func AddBuiltinMessages(mp map[string]string)

+ func AddCustomType(fn CustomTypeFunc, types ...any)

+ func AddFilter(name string, filterFunc any)

+ func AddFilters(m map[string]any)

+ func AddGlobalMessages(mp map[string]string)

+ func AddValidator(name string, checkFunc any)

+ func AddValidators(m map[string]any)

+ func AfterDate(srcDate, dstDate string) bool

+ func AfterOrEqualDate(srcDate, dstDate string) bool

+ func BeforeDate(srcDate, dstDate string) bool

+ func BeforeOrEqualDate(srcDate, dstDate string) bool

+ func Between(val, minVal, maxVal any) bool

+ func BuiltinMessages() map[string]string

+ func ByteLength(str string, minLen int, maxLen ...int) bool

+ func CalcLength(val any) int

+ func CallByValue(fv reflect.Value, args ...any) []reflect.Value

+ func Config(fn func(opt *GlobalOption))

+ func Contains(s, sub any) bool

+ func CopyGlobalMessages() map[string]string

+ func DateFormat(s string, layout string) bool

+ func EndsWith(s, sub string) bool

+ func Enum(val, enum any) bool

+ func Gt(val, minVal any) bool

+ func Gte(val, minVal any) bool

+ func HasLowerCase(s string) bool

+ func HasURLSchema(s string) bool

+ func HasUpperCase(s string) bool

+ func HasWhitespace(s string) bool

+ func IntEqual(val any, wantVal int64) bool

+ func IsASCII(s string) bool

+ func IsActiveURL(s string) bool

+ func IsAlpha(s string) bool

+ func IsAlphaDash(s string) bool

+ func IsAlphaNum(s string) bool

+ func IsArray(val any, strict ...bool) (ok bool)

+ func IsBase64(s string) bool

+ func IsBool(val any) bool

+ func IsCIDR(s string) bool

+ func IsCIDRv4(s string) bool

+ func IsCIDRv6(s string) bool

+ func IsCnMobile(s string) bool

+ func IsDNSName(s string) bool

+ func IsDataURI(s string) bool

+ func IsDate(srcDate string, layouts ...string) bool

+ func IsDirPath(path string) bool

+ func IsEmail(s string) bool

+ func IsEmpty(val any) bool

+ func IsEqual(val, wantVal any) bool

+ func IsFilePath(path string) bool

+ func IsFloat(val any) bool

+ func IsFullURL(s string) bool

+ func IsHexColor(s string) bool

+ func IsHexadecimal(s string) bool

+ func IsIP(s string) bool

+ func IsIPv4(s string) bool

+ func IsIPv6(s string) bool

+ func IsISBN10(s string) bool

+ func IsISBN13(s string) bool

+ func IsInt(val any, minAndMax ...int64) (ok bool)

+ func IsIntString(s string) bool

+ func IsInts(val any) bool

+ func IsJSON(s string) bool

+ func IsLatitude(s string) bool

+ func IsLongitude(s string) bool

+ func IsMAC(s string) bool

+ func IsMap(val any) (ok bool)

+ func IsMultiByte(s string) bool

+ func IsNilObj(val any) bool

+ func IsNumber(v any) bool

+ func IsNumeric(v any) bool

+ func IsPrintableASCII(s string) bool

+ func IsRGBColor(s string) bool

+ func IsSlice(val any) (ok bool)

+ func IsString(val any, minAndMaxLen ...int) (ok bool)

+ func IsStringNumber(s string) bool

+ func IsStrings(val any) (ok bool)

+ func IsURL(s string) bool

+ func IsUUID(s string) bool

+ func IsUUID3(s string) bool

+ func IsUUID4(s string) bool

+ func IsUUID5(s string) bool

+ func IsUint(val any) bool

+ func IsUnixPath(s string) bool

+ func IsWinPath(s string) bool

+ func IsZero(v reflect.Value) bool

+ func Length(val any, wantLen int) bool

+ func Lt(val, maxVal any) bool

+ func Lte(val, maxVal any) bool

+ func Max(val, maxVal any) bool

+ func MaxLength(val any, maxLen int) bool

+ func Min(val, minVal any) bool

+ func MinLength(val any, minLen int) bool

+ func NotContains(s, sub any) bool

+ func NotEqual(val, wantVal any) bool

+ func NotIn(val, enum any) bool

+ func PathExists(path string) bool

+ func Regexp(str string, pattern string) bool

+ func ResetCustomTypes()

+ func ResetOption()

+ func ResetTypeCache()

+ func RuneLength(val any, minLen int, maxLen ...int) bool

+ func SetBuiltinMessages(mp map[string]string)

+ func StartsWith(s, sub string) bool

+ func StringContains(s, sub string) bool

+ func StringLength(val any, minLen int, maxLen ...int) bool

+ func Val(val any, rule string) error

+ func ValidatorName(name string) string

+ func Validators() map[string]int8

+ func ValueIsEmpty(v reflect.Value) bool

+ func Var(val any, rule string) error

+ type ConfigValidationFace interface

+ ConfigValidation func(v *Validation)

+ type CustomMessagesFace interface

+ Messages func() map[string]string

+ type CustomTypeFunc func(field reflect.Value) any

+ type DataFace interface

+ Create func(err ...error) *Validation

+ Get func(key string) (val any, exist bool)

+ Set func(field string, val any) (any, error)

+ Src func() any

+ TryGet func(key string) (val any, exist, zero bool)

+ Type func() uint8

+ Validation func(err ...error) *Validation

+ func FromRequest(r *http.Request, maxMemoryLimit ...int64) (DataFace, error)

+ type Errors map[string]MS

+ func (es Errors) Add(field, validator, message string)

+ func (es Errors) All() map[string]map[string]string

+ func (es Errors) Empty() bool

+ func (es Errors) ErrOrNil() error

+ func (es Errors) Error() string

+ func (es Errors) Field(field string) map[string]string

+ func (es Errors) FieldOne(field string) string

+ func (es Errors) HasField(field string) bool

+ func (es Errors) JSON() []byte

+ func (es Errors) One() string

+ func (es Errors) OneError() error

+ func (es Errors) Random() string

+ func (es Errors) String() string

+ type Factory struct

+ func NewFactory() *Factory

+ func (f *Factory) Map(m map[string]any, scene ...string) *Validation

+ func (f *Factory) Struct(s any, scene ...string) *Validation

+ type FieldTranslatorFace interface

+ Translates func() map[string]string

+ type FilterRule struct

+ func (r *FilterRule) AddFilters(filters ...string) *FilterRule

+ func (r *FilterRule) Apply(v *Validation) (err error)

+ func (r *FilterRule) Fields() []string

+ type FormData struct

+ Files map[string][]*multipart.FileHeader

+ Form url.Values

+ func FromQuery(values url.Values) *FormData

+ func FromURLValues(values url.Values) *FormData

+ func (d *FormData) Add(key, value string)

+ func (d *FormData) AddFile(key string, files ...*multipart.FileHeader)

+ func (d *FormData) AddFiles(filesMap map[string][]*multipart.FileHeader)

+ func (d *FormData) AddValues(values url.Values)

+ func (d *FormData) Bool(key string) bool

+ func (d *FormData) Create(err ...error) *Validation

+ func (d *FormData) Del(key string)

+ func (d *FormData) DelFile(key string)

+ func (d *FormData) Encode() string

+ func (d *FormData) FileBytes(field string) ([]byte, error)

+ func (d *FormData) FileMimeType(field string) (mime string)

+ func (d *FormData) FilesMimeType(field string) (mimes []string)

+ func (d *FormData) Float(key string) float64

+ func (d *FormData) Get(key string) (any, bool)

+ func (d *FormData) GetFile(key string) *multipart.FileHeader

+ func (d *FormData) GetFiles(key string) []*multipart.FileHeader

+ func (d *FormData) Has(key string) bool

+ func (d *FormData) HasField(key string) bool

+ func (d *FormData) HasFile(key string) bool

+ func (d *FormData) Int(key string) int

+ func (d *FormData) Int64(key string) int64

+ func (d *FormData) Set(field string, val any) (newVal any, err error)

+ func (d *FormData) Src() any

+ func (d *FormData) String(key string) string

+ func (d *FormData) Strings(key string) []string

+ func (d *FormData) TryGet(key string) (val any, exist, zero bool)

+ func (d *FormData) Type() uint8

+ func (d *FormData) Validation(err ...error) *Validation

+ type GlobalOption struct

+ CheckDefault bool

+ CheckSubOnParentMarked bool

+ CheckZero bool

+ DefaultTag string

+ ErrKeyFmt int8

+ ErrShowValue bool

+ FieldTag string

+ FilterTag string

+ LabelTag string

+ MessageTag string

+ RestoreRequestBody bool

+ SkipOnEmpty bool

+ StopOnError bool

+ UpdateSource bool

+ ValidatePrivateFields bool

+ ValidateTag string

+ func Option() GlobalOption

+ type M map[string]any

+ type MS map[string]string

+ func (ms MS) One() string

+ func (ms MS) OrderedRange(fn func(key, value string))

+ func (ms MS) String() string

+ type MapData struct

+ Map map[string]any

+ func FromJSON(s string) (*MapData, error)

+ func FromJSONBytes(bs []byte) (*MapData, error)

+ func FromMap(m map[string]any) *MapData

+ func (d *MapData) BindJSON(ptr any) error

+ func (d *MapData) Create(err ...error) *Validation

+ func (d *MapData) Get(field string) (any, bool)

+ func (d *MapData) Set(field string, val any) (any, error)

+ func (d *MapData) Src() any

+ func (d *MapData) TryGet(field string) (val any, exist, zero bool)

+ func (d *MapData) Type() uint8

+ func (d *MapData) Validation(err ...error) *Validation

+ type MarshalFunc func(v any) ([]byte, error)

+ type NilObject = reflectx.NilObject

+ type Rule struct

+ func NewRule(fields, validator string, args ...any) *Rule

+ func (r *Rule) Apply(v *Validation) (stop bool)

+ func (r *Rule) Fields() []string

+ func (r *Rule) SetBeforeFunc(fn func(v *Validation) bool)

+ func (r *Rule) SetCheckFunc(checkFunc any) *Rule

+ func (r *Rule) SetFilterFunc(fn func(val any) (any, error)) *Rule

+ func (r *Rule) SetMessage(errMsg string) *Rule

+ func (r *Rule) SetMessages(msgMap MS) *Rule

+ func (r *Rule) SetOptional(optional bool)

+ func (r *Rule) SetScene(scene string) *Rule

+ func (r *Rule) SetSkipEmpty(skipEmpty bool)

+ type Rules []*Rule

+ type SValues map[string][]string

+ type StructData struct

+ FilterTag string

+ ValidateTag string

+ func FromStruct(s any) (*StructData, error)

+ func (d *StructData) Create(err ...error) *Validation

+ func (d *StructData) FuncValue(name string) (reflect.Value, bool)

+ func (d *StructData) Get(field string) (val any, exist bool)

+ func (d *StructData) HasField(field string) bool

+ func (d *StructData) Set(field string, val any) (newVal any, err error)

+ func (d *StructData) Src() any

+ func (d *StructData) TryGet(field string) (val any, exist, zero bool)

+ func (d *StructData) Type() uint8

+ func (d *StructData) Validation(err ...error) *Validation

+ type Translator struct

+ func NewTranslator() *Translator

+ func (t *Translator) AddFieldMap(fieldMap map[string]string)

+ func (t *Translator) AddLabelMap(fieldMap map[string]string)

+ func (t *Translator) AddMessage(key, msg string)

+ func (t *Translator) AddMessages(data map[string]string)

+ func (t *Translator) FieldMap() map[string]string

+ func (t *Translator) FieldName(field string) string

+ func (t *Translator) HasField(field string) bool

+ func (t *Translator) HasLabel(field string) bool

+ func (t *Translator) HasMessage(key string) bool

+ func (t *Translator) LabelMap() map[string]string

+ func (t *Translator) LabelName(field string) string

+ func (t *Translator) LookupLabel(field string) (string, bool)

+ func (t *Translator) Message(validator, field string, args ...any) (msg string)

+ func (t *Translator) Reset()

+ type UnmarshalFunc func(data []byte, ptr any) error

+ type Validation struct

+ CheckDefault bool

+ ErrShowValue bool

+ Errors Errors

+ SkipOnEmpty bool

+ StopOnError bool

+ UpdateSource bool

+ func JSON(s string, scene ...string) *Validation

+ func Map(m map[string]any, scene ...string) *Validation

+ func New(data any, scene ...string) *Validation

+ func NewEmpty(scene ...string) *Validation

+ func NewValidation(data DataFace, scene ...string) *Validation

+ func Request(r *http.Request) *Validation

+ func Struct(s any, scene ...string) *Validation

+ func (v *Validation) AddError(field, validator, msg string)

+ func (v *Validation) AddErrorf(field, msgFormat string, args ...any)

+ func (v *Validation) AddFilter(name string, filterFunc any)

+ func (v *Validation) AddFilters(m map[string]any)

+ func (v *Validation) AddMessages(m map[string]string)

+ func (v *Validation) AddRule(fields, validator string, args ...any) *Rule

+ func (v *Validation) AddTranslates(m map[string]string)

+ func (v *Validation) AddValidator(name string, checkFunc any) *Validation

+ func (v *Validation) AddValidators(m map[string]any) *Validation

+ func (v *Validation) AppendRule(rule *Rule) *Rule

+ func (v *Validation) AppendRules(rules ...*Rule) *Validation

+ func (v *Validation) AtScene(scene string) *Validation

+ func (v *Validation) BindSafeData(ptr any) error

+ func (v *Validation) BindStruct(ptr any) error

+ func (v *Validation) ConfigRules(mp MS) *Validation

+ func (v *Validation) EqField(val any, dstField string) bool

+ func (v *Validation) FilterFuncValue(name string) reflect.Value

+ func (v *Validation) FilterRule(field string, rule string) *FilterRule

+ func (v *Validation) FilterRules(rules map[string]string) *Validation

+ func (v *Validation) Filtered(key string) any

+ func (v *Validation) FilteredData() M

+ func (v *Validation) Filtering() bool

+ func (v *Validation) Get(key string) (val any, exist bool)

+ func (v *Validation) GetDefValue(field string) (any, bool)

+ func (v *Validation) GetSafe(key string) any

+ func (v *Validation) GetWithDefault(key string) (val any, exist, isDefault bool)

+ func (v *Validation) GtField(val any, dstField string) bool

+ func (v *Validation) GteField(val any, dstField string) bool

+ func (v *Validation) HasValidator(name string) bool

+ func (v *Validation) InMimeTypes(fd *FormData, field, mimeType string, moreTypes ...string) bool

+ func (v *Validation) InScene(scene string) *Validation

+ func (v *Validation) IsFail() bool

+ func (v *Validation) IsFormFile(fd *FormData, field string) (ok bool)

+ func (v *Validation) IsFormImage(fd *FormData, field string, exts ...string) (ok bool)

+ func (v *Validation) IsOK() bool

+ func (v *Validation) IsSuccess() bool

+ func (v *Validation) LtField(val any, dstField string) bool

+ func (v *Validation) LteField(val any, dstField string) bool

+ func (v *Validation) NeField(val any, dstField string) bool

+ func (v *Validation) Raw(key string) (any, bool)

+ func (v *Validation) RawVal(key string) any

+ func (v *Validation) Release()

+ func (v *Validation) Required(field string, val any) bool

+ func (v *Validation) RequiredIf(sourceField string, val any, kvs ...string) bool

+ func (v *Validation) RequiredUnless(sourceField string, val any, kvs ...string) bool

+ func (v *Validation) RequiredWith(sourceField string, val any, fields ...string) bool

+ func (v *Validation) RequiredWithAll(sourceField string, val any, fields ...string) bool

+ func (v *Validation) RequiredWithout(sourceField string, val any, fields ...string) bool

+ func (v *Validation) RequiredWithoutAll(sourceField string, val any, fields ...string) bool

+ func (v *Validation) Reset()

+ func (v *Validation) ResetResult()

+ func (v *Validation) RuleOneOf(val any, rules any) bool

+ func (v *Validation) Safe(key string) (val any, ok bool)

+ func (v *Validation) SafeData() M

+ func (v *Validation) SafeVal(key string) any

+ func (v *Validation) Sanitize() bool

+ func (v *Validation) Scene() string

+ func (v *Validation) SceneFields() []string

+ func (v *Validation) Set(field string, val any) error

+ func (v *Validation) SetDefValue(field string, val any)

+ func (v *Validation) SetScene(scene ...string) *Validation

+ func (v *Validation) StringMessage(field, message string) *Validation

+ func (v *Validation) StringMessages(mp MS) *Validation

+ func (v *Validation) StringRule(field, rule string, filterRule ...string) *Validation

+ func (v *Validation) StringRules(mp MS) *Validation

+ func (v *Validation) Trans() *Translator

+ func (v *Validation) Validate(scene ...string) bool

+ func (v *Validation) ValidateData(data DataFace) bool

+ func (v *Validation) ValidateE(scene ...string) Errors

+ func (v *Validation) ValidateErr(scene ...string) error

+ func (v *Validation) Validators(withGlobal bool) map[string]int8

+ func (v *Validation) WithError(err error) *Validation

+ func (v *Validation) WithMessages(m map[string]string) *Validation

+ func (v *Validation) WithScenarios(scenes SValues) *Validation

+ func (v *Validation) WithScenes(scenes map[string][]string) *Validation

+ func (v *Validation) WithSelf(fn func(v *Validation)) *Validation

+ func (v *Validation) WithTrans(trans *Translator) *Validation

+ func (v *Validation) WithTranslates(m map[string]string) *Validation

Other modules containing this package

github.com/gookit/validate