xvalidator

func And ¶

func And(fns ...validator.Func) validator.Func

And represents the intersection of multiple validators, just like ',' in validator tag.

func DateTimeValidator ¶

func DateTimeValidator(layout string) validator.Func

DateTimeValidator represents datetime validator using given layout.

func DefaultRegistrationFunc ¶

func DefaultRegistrationFunc(tag string, translation string, override bool) validator.RegisterTranslationsFunc

DefaultRegistrationFunc returns a validator.RegisterTranslationsFunc function, it uses given tag, translation and override flag to register normal translation information for a UtTranslator, {#} is the only replacement type accepted and will be set by validator.TranslationFunc.

This function can be used for validator.Validate RegisterTranslation() method's second parameter translationFn, also see ApplyTranslator.

func DefaultTranslateFunc ¶

func DefaultTranslateFunc() validator.TranslationFunc

DefaultTranslateFunc returns a validator.TranslationFunc function, it uses the struct field name as {0} and the validator tag param as {1} from validator.FieldError's methods to create the translation for given tag. Note that if the tag is not found, it will log a warning message.

This function can be used for validator.Validate RegisterTranslation() method's third parameter registerFn, also see ApplyTranslator.

func EqualValidator ¶

func EqualValidator(p interface{}) validator.Func

EqualValidator represents `eq` validator tag. See https://godoc.org/github.com/go-playground/validator#hdr-Equals. For strings & numbers, eq will ensure that the value is equal to the parameter given. For slices, arrays, and maps, validates the number of items.

func FlattenValidationErrors ¶

func FlattenValidationErrors(err validator.ValidationErrors, useNamespace bool) map[string]string

FlattenValidationErrors flattens all the validator.FieldError in validator.ValidationErrors to a field-message map without using UtTranslator. Here values from returned map come from the error message directly. Also see TranslateValidationErrors for more.

Example:

type Struct struct {
	Int int    `validate:"required"`
	Str string `validate:"required"`
}
val := validator.New()
// ...
err := val.Struct(&Struct{}).(validator.ValidationErrors)
FlattenValidationErrors(err, true)  // => {Struct.int: Field validation for 'int' failed on the 'required' tag, Struct.str: Field validation for 'str' failed on the 'required' tag}
FlattenValidationErrors(err, false) // => {int:        Field validation for 'int' failed on the 'required' tag, str:        Field validation for 'str' failed on the 'required' tag}

func GreaterThenOrEqualValidator ¶

func GreaterThenOrEqualValidator(p interface{}) validator.Func

GreaterThenOrEqualValidator represents `gte` validator tag. See https://godoc.org/github.com/go-playground/validator#hdr-Greater_Than_or_Equal. For numbers, gte will ensure that the value is greater or equal to the parameter given. For strings, it checks that the string length is at least that number of characters. For slices, arrays, and maps, validates the number of items.

func GreaterThenValidator ¶

func GreaterThenValidator(p interface{}) validator.Func

GreaterThenValidator represents `gt` validator tag. See https://godoc.org/github.com/go-playground/validator#hdr-Greater_Than. For numbers, this will ensure that the value is greater than the parameter given. For strings, it checks that the string length is greater than that number of characters. For slices, arrays and maps it validates the number of items.

func IsRequiredError ¶

func IsRequiredError(err error) bool

IsRequiredError returns true if the error is validator.ValidationErrors which contains "required" tag.

func IsValidationError ¶

func IsValidationError(err error) bool

IsValidationError returns true if the error is validator.ValidationErrors.

func LenValidator ¶

func LenValidator(p interface{}) validator.Func

LenValidator represents `len` validator tag. See https://godoc.org/github.com/go-playground/validator#hdr-Length. For numbers, length will ensure that the value is equal to the parameter given. For strings, it checks that the string length is exactly that number of characters. For slices, arrays, and maps, validates the number of items.

func LengthInRangeValidator ¶

func LengthInRangeValidator(min, max interface{}) validator.Func

LengthInRangeValidator represents `min,max` validator tag, equals to combine GreaterThenOrEqualValidator and LessThenOrEqualValidator with And.

func LengthOutOfRangeValidator ¶

func LengthOutOfRangeValidator(min, max interface{}) validator.Func

LengthOutOfRangeValidator represents `min|max` validator tag, equals to combine GreaterThenOrEqualValidator and LessThenOrEqualValidator with Or.

func LessThenOrEqualValidator ¶

func LessThenOrEqualValidator(p interface{}) validator.Func

LessThenOrEqualValidator represents `lte` validator tag. See https://godoc.org/github.com/go-playground/validator#hdr-Less_Than_or_Equal. For numbers, lte will ensure that the value is less than or equal to the parameter given. For strings, it checks that the string length is at most that number of characters. For slices, arrays, and maps, validates the number of items.

func LessThenValidator ¶

func LessThenValidator(p interface{}) validator.Func

LessThenValidator represents `lt` validator tag. See https://godoc.org/github.com/go-playground/validator#hdr-Less_Than. For numbers, this will ensure that the value is less than the parameter given. For strings, it checks that the string length is less than that number of characters. For slices, arrays, and maps it validates the number of items.

func MergeMapToError ¶

func MergeMapToError(result map[string]string) error

MergeMapToError generates a single error from given map generated by translating (TranslateValidationErrors) or flattening (FlattenValidationErrors), to represent the translated or flattened error from validator.ValidationErrors or xvalidator.MultiFieldsError.

func Not ¶

func Not(fn validator.Func) validator.Func

Not represents the inverse result of given validator.

func NotEqualValidator ¶

func NotEqualValidator(p interface{}) validator.Func

NotEqualValidator represents `ne` validator tag. See https://godoc.org/github.com/go-playground/validator#hdr-Not_Equal. For strings & numbers, ne will ensure that the value is not equal to the parameter given. For slices, arrays, and maps, validates the number of items.

func OneofValidator ¶

func OneofValidator(ps ...interface{}) validator.Func

OneofValidator represents `oneof` validator tag. See https://godoc.org/github.com/go-playground/validator#hdr-One_Of. For strings, ints, uints, and floats, oneof will ensure that the value is one of the values in the parameter.

func Or ¶

func Or(fns ...validator.Func) validator.Func

Or represents the union of multiple validators, just like '|' in validator tag. See https://godoc.org/github.com/go-playground/validator#hdr-Or_Operator.

func ParamRegexpValidator ¶

func ParamRegexpValidator() validator.Func

ParamRegexpValidator represents parameterized regexp validator, just like `regexp: xxx`. For more regexps, see xvalidator.regexps package and https://github.com/go-playground/validator/blob/v10.11.1/regexes.go.

func RegexpValidator ¶

func RegexpValidator(re *regexp.Regexp) validator.Func

RegexpValidator represents regexp validator using given regexp.

func TranslateValidationErrors ¶

func TranslateValidationErrors(err validator.ValidationErrors, ut UtTranslator, useNamespace bool) map[string]string

TranslateValidationErrors translates all validator.FieldError in validator.ValidationErrors using given UtTranslator to a field-message map. Note that if you set useNamespace to true, keys from returned map will be shown in "$struct.$field" format, the same as validator.ValidationErrors' Translate(), otherwise in "$field" format.

Example:

type Struct struct {
	Int int    `validate:"required"`
	Str string `validate:"required"`
}
val := validator.New()
// ...
err := val.Struct(&Struct{}).(validator.ValidationErrors)
TranslateValidationErrors(err, trans, true)  // => {Struct.int: int is a required field, Struct.str: str is a required field}
TranslateValidationErrors(err, trans, false) // => {int:        int is a required field, str:        str is a required field}

func UseTagAsFieldName ¶

func UseTagAsFieldName(v *validator.Validate, tagName ...string)

UseTagAsFieldName sets a specific struct tag as field's alternate name, this name will be used in validator.FieldError's Namespace() and Field() methods, and will change the error string and translated result. You can pass more than one tagName, and it will use the current tagName if it exists and is valid.

Note: the origin field name will be returned by StructField() and StructNamespace() methods; 2. you can pass empty tagName to remove this alternate name.

Attention: please use this function before all validate methods, because any validation method will change the validator's structCache, even if you remove alternate name by `UseTagAsFieldName(v, "")`, structCache will be not cleared.

Example:

v := validator.New()
xvalidator.UseTagAsFieldName(v, "json", "yaml")
// xvalidator.UseTagAsFieldName(v) // remove field's alternate name
type Typ struct {
	Str string `validate:"required,gt=2,lte=10" json:"sss"`
}
errs := v.Struct(&s{"01234567890"}).(validator.ValidationErrors)
// errs[0].Field()           => sss     (alternate name)
// errs[0].Namespace()       => Typ.sss (alternate name with struct typename)
// errs[0].StructField()     => Str     (origin field name)
// errs[0].StructNamespace() => Typ.Str (origin field name with struct typename)
// errs[0].Error()           => Key: 'Typ.sss' Error:Field validation for 'sss' failed on the 'lte' tag
//                                   |-------|                            |---|               |---|
//                                   Namespace                            Field                Tag