validator

package module
v5.10.1+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 9, 2015 License: MIT Imports: 12 Imported by: 0

README

Package validator

Build Status Coverage Status GoDoc

Package validator implements value validations for structs and individual fields based on tags.

It has the following unique features:

  • Cross Field and Cross Struct validations.
  • Slice, Array and Map diving, which allows any or all levels of a multidimensional field to be validated.
  • Handles type interface by determining it's underlying type prior to validation.

Installation

Use go get.

go get gopkg.in/bluesuncorp/validator.v5

or to update

go get -u gopkg.in/bluesuncorp/validator.v5

Then import the validator package into your own code.

import "gopkg.in/bluesuncorp/validator.v5"

Usage and documentation

Please see http://godoc.org/gopkg.in/bluesuncorp/validator.v5 for detailed usage docs.

Example:
package main

import (
	"fmt"

	"gopkg.in/bluesuncorp/validator.v5"
)

// User contains user information
type User struct {
	FirstName      string     `validate:"required"`
	LastName       string     `validate:"required"`
	Age            uint8      `validate:"gte=0,lte=130"`
	Email          string     `validate:"required,email"`
	FavouriteColor string     `validate:"hexcolor|rgb|rgba"`
	Addresses      []*Address `validate:"required,dive,required"` // a person can have a home and cottage...
}

// Address houses a users address information
type Address struct {
	Street string `validate:"required"`
	City   string `validate:"required"`
	Planet string `validate:"required"`
	Phone  string `validate:"required"`
}

var validate *validator.Validate

func main() {

	validate = validator.New("validate", validator.BakedInValidators)

	address := &Address{
		Street: "Eavesdown Docks",
		Planet: "Persphone",
		Phone:  "none",
	}

	user := &User{
		FirstName:      "Badger",
		LastName:       "Smith",
		Age:            135,
		Email:          "Badger.Smith@gmail.com",
		FavouriteColor: "#000",
		Addresses:      []*Address{address},
	}

	// returns nil or *StructErrors
	errs := validate.Struct(user)

	if errs != nil {

		// err will be of type *FieldError
		err := errs.Errors["Age"]
		fmt.Println(err.Error()) // output: Field validation for "Age" failed on the "lte" tag
		fmt.Println(err.Field)   // output: Age
		fmt.Println(err.Tag)     // output: lte
		fmt.Println(err.Kind)    // output: uint8
		fmt.Println(err.Type)    // output: uint8
		fmt.Println(err.Param)   // output: 130
		fmt.Println(err.Value)   // output: 135

		// or if you prefer you can use the Flatten function
		// NOTE: I find this usefull when using a more hard static approach of checking field errors.
		// The above, is best for passing to some generic code to say parse the errors. i.e. I pass errs
		// to a routine which loops through the errors, creates and translates the error message into the
		// users locale and returns a map of map[string]string // field and error which I then use
		// within the HTML rendering.

		flat := errs.Flatten()
		fmt.Println(flat) // output: map[Age:Field validation for "Age" failed on the "lte" tag Addresses[0].Address.City:Field validation for "City" failed on the "required" tag]
		err = flat["Addresses[0].Address.City"]
		fmt.Println(err.Field) // output: City
		fmt.Println(err.Tag)   // output: required
		fmt.Println(err.Kind)  // output: string
		fmt.Println(err.Type)  // output: string
		fmt.Println(err.Param) // output:
		fmt.Println(err.Value) // output:

		// from here you can create your own error messages in whatever language you wish
		return
	}

	// save user to database
}

Benchmarks

Run on MacBook Pro (Retina, 15-inch, Late 2013) 2.6 GHz Intel Core i7 16 GB 1600 MHz DDR3
$ go test -cpu=4 -bench=. -benchmem=true
PASS
BenchmarkValidateField-4	 		 3000000	       429 ns/op	     192 B/op	       2 allocs/op
BenchmarkValidateStructSimple-4	  	  500000	      2877 ns/op	     657 B/op	      10 allocs/op
BenchmarkTemplateParallelSimple-4	  500000	      3097 ns/op	     657 B/op	      10 allocs/op
BenchmarkValidateStructLarge-4	  	  100000	     15228 ns/op	    4350 B/op	      62 allocs/op
BenchmarkTemplateParallelLarge-4	  100000	     14257 ns/op	    4354 B/op	      62 allocs/op

How to Contribute

There will always be a development branch for each version i.e. v1-development. In order to contribute, please make your pull requests against those branches.

If the changes being proposed or requested are breaking changes, please create an issue, for discussion or create a pull request against the highest development branch for example this package has a v1 and v1-development branch however, there will also be a v2-development brach even though v2 doesn't exist yet.

I strongly encourage everyone whom creates a custom validation function to contribute them and help make this package even better.

License

Distributed under MIT License, please see license file in code for more details.

Documentation

Overview

Package validator implements value validations for structs and individual fields based on tags. It can also handle Cross Field and Cross Struct validation for nested structs.

Validate

validate := validator.New("validate", validator.BakedInValidators)

errs := validate.Struct(//your struct)
valErr := validate.Field(field, "omitempty,min=1,max=10")

A simple example usage:

type UserDetail struct {
	Details string `validate:"-"`
}

type User struct {
	Name         string     `validate:"required,max=60"`
	PreferedName string     `validate:"omitempty,max=60"`
	Sub          UserDetail
}

user := &User {
	Name: "",
}

// errs will contain a hierarchical list of errors
// using the StructErrors struct
// or nil if no errors exist
errs := validate.Struct(user)

// in this case 1 error Name is required
errs.Struct will be "User"
errs.StructErrors will be empty <-- fields that were structs
errs.Errors will have 1 error of type FieldError

NOTE: Anonymous Structs - they don't have names so expect the Struct name
within StructErrors to be blank.

Error Handling

The error can be used like so

fieldErr, _ := errs["Name"]
fieldErr.Field    // "Name"
fieldErr.ErrorTag // "required"

Both StructErrors and FieldError implement the Error interface but it's intended use is for development + debugging, not a production error message.

fieldErr.Error() // Field validation for "Name" failed on the "required" tag
errs.Error()
// Struct: User
// Field validation for "Name" failed on the "required" tag

Why not a better error message? because this library intends for you to handle your own error messages

Why should I handle my own errors? Many reasons, for us building an internationalized application I needed to know the field and what validation failed so that I could provide an error in the users specific language.

if fieldErr.Field == "Name" {
	switch fieldErr.ErrorTag
	case "required":
		return "Translated string based on field + error"
	default:
	return "Translated string based on field"
}

The hierarchical error structure is hard to work with sometimes.. Agreed Flatten function to the rescue! Flatten will return a map of FieldError's but the field name will be namespaced.

// if UserDetail Details field failed validation
Field will be "Sub.Details"

// for Name
Field will be "Name"

Custom Functions

Custom functions can be added

//Structure
func customFunc(top interface{}, current interface{}, field interface{}, param string) bool {

	if whatever {
		return false
	}

	return true
}

validate.AddFunction("custom tag name", customFunc)
// NOTES: using the same tag name as an existing function
//        will overwrite the existing one

Cross Field Validation

Cross Field Validation can be implemented, for example Start & End Date range validation

// NOTE: when calling validate.Struct(val) val will be the top level struct passed
//       into the function
//       when calling validate.FieldWithValue(val, field, tag) val will be
//       whatever you pass, struct, field...
//       when calling validate.Field(field, tag) val will be nil
//
// Because of the specific requirements and field names within each persons project that
// uses this library it is likely that custom functions will need to be created for your
// Cross Field Validation needs, however there are some build in Generic Cross Field validations,
// see Baked In Validators and Tags below

func isDateRangeValid(val interface{}, field interface{}, param string) bool {

	myStruct := val.(myStructType)

	if myStruct.Start.After(field.(time.Time)) {
		return false
	}

	return true
}

Multiple Validators

Multiple validators on a field will process in the order defined

type Test struct {
	Field `validate:"max=10,min=1"`
}

// max will be checked then min

Bad Validator definitions are not handled by the library

type Test struct {
	Field `validate:"min=10,max=0"`
}

// this definition of min max will never validate

Baked In Validators and Tags

NOTE: Baked In Cross field validation only compares fields on the same struct, if cross field + cross struct validation is needed your own custom validator should be implemented.

NOTE2: comma is the default separator of validation tags, if you wish to have a comma included within the parameter i.e. excludesall=, you will need to use the UTF-8 hex representation 0x2C, which is replaced in the code as a comma, so the above will become excludesall=0x2C

Here is a list of the current built in validators:

-
	Tells the validation to skip this struct field; this is particularily
	handy in ignoring embedded structs from being validated. (Usage: -)

|
	This is the 'or' operator allowing multiple validators to be used and
	accepted. (Usage: rbg|rgba) <-- this would allow either rgb or rgba
	colors to be accepted. This can also be combined with 'and' for example
	( Usage: omitempty,rgb|rgba)

structonly
	When a field that is a nest struct in encountered and contains this flag
	any validation on the nested struct such as "required" will be run, but
	none of the nested struct fields will be validated. This is usefull if
	inside of you program you know the struct will be valid, but need to
	verify it has been assigned.

omitempty
	Allows conditional validation, for example if a field is not set with
	a value (Determined by the required validator) then other validation
	such as min or max won't run, but if a value is set validation will run.
	(Usage: omitempty)

dive
	This tells the validator to dive into a slice, array or map and validate that
	level of the slice, array or map with the validation tags that follow.
	Multidimensional nesting is also supported, each level you wish to dive will
	require another dive tag. (Usage: dive)
	Example: [][]string with validation tag "gt=0,dive,len=1,dive,required"
	gt=0 will be applied to []
	len=1 will be applied to []string
	required will be applied to string
	Example2: [][]string with validation tag "gt=0,dive,dive,required"
	gt=0 will be applied to []
	[]string will be spared validation
	required will be applied to string
	NOTE: in Example2 if the required validation failed, but all others passed
	the hierarchy of FieldError's in the middle with have their IsPlaceHolder field
	set to true. If a FieldError has IsSliceOrMap=true or IsMap=true then the
	FieldError is a Slice or Map field and if IsPlaceHolder=true then contains errors
	within its SliceOrArrayErrs or MapErrs fields.

required
	This validates that the value is not the data types default value.
	For numbers ensures value is not zero. For strings ensures value is
	not "". For slices, arrays, and maps, ensures the length is not zero.
	(Usage: required)

len
	For numbers, max 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. (Usage: len=10)

max
	For numbers, max 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. (Usage: max=10)

min
	For numbers, min 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. (Usage: min=10)

eq
	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. (Usage: eq=10)

ne
	For strings & numbers, eq will ensure that the value is not
	equal to the parameter given. For slices, arrays, and maps,
	validates the number of items. (Usage: eq=10)

gt
	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. (Usage: gt=10)
	For time.Time ensures the time value is greater than time.Now.UTC()
	(Usage: gt)

gte
	Same as 'min' above. Kept both to make terminology with 'len' easier
	(Usage: gte=10)
	For time.Time ensures the time value is greater than or equal to time.Now.UTC()
	(Usage: gte)

lt
	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.
	(Usage: lt=10)
	For time.Time ensures the time value is less than time.Now.UTC()
	(Usage: lt)

lte
	Same as 'max' above. Kept both to make terminology with 'len' easier
	(Usage: lte=10)
	For time.Time ensures the time value is less than or equal to time.Now.UTC()
	(Usage: lte)

eqfield
	This will validate the field value against another fields value either within
	a struct or passed in field.
	usage examples are for validation of a password and confirm password:
	Validation on Password field using validate.Struct Usage(eqfield=ConfirmPassword)
	Validating by field validate.FieldWithValue(password, confirmpassword, "eqfield")

nefield
	This will validate the field value against another fields value either within
	a struct or passed in field.
	usage examples are for ensuring two colors are not the same:
	Validation on Color field using validate.Struct Usage(nefield=Color2)
	Validating by field validate.FieldWithValue(color1, color2, "nefield")

gtfield
	Only valid for Numbers and time.Time types, this will validate the field value
	against another fields value either within a struct or passed in field.
	usage examples are for validation of a Start and End date:
	Validation on End field using validate.Struct Usage(gtfield=Start)
	Validating by field validate.FieldWithValue(start, end, "gtfield")

gtefield
	Only valid for Numbers and time.Time types, this will validate the field value
	against another fields value either within a struct or passed in field.
	usage examples are for validation of a Start and End date:
	Validation on End field using validate.Struct Usage(gtefield=Start)
	Validating by field validate.FieldWithValue(start, end, "gtefield")

ltfield
	Only valid for Numbers and time.Time types, this will validate the field value
	against another fields value either within a struct or passed in field.
	usage examples are for validation of a Start and End date:
	Validation on End field using validate.Struct Usage(ltfield=Start)
	Validating by field validate.FieldWithValue(start, end, "ltfield")

ltefield
	Only valid for Numbers and time.Time types, this will validate the field value
	against another fields value either within a struct or passed in field.
	usage examples are for validation of a Start and End date:
	Validation on End field using validate.Struct Usage(ltefield=Start)
	Validating by field validate.FieldWithValue(start, end, "ltefield")

alpha
	This validates that a string value contains alpha characters only
	(Usage: alpha)

alphanum
	This validates that a string value contains alphanumeric characters only
	(Usage: alphanum)

numeric
	This validates that a string value contains a basic numeric value.
	basic excludes exponents etc...
	(Usage: numeric)

hexadecimal
	This validates that a string value contains a valid hexadecimal.
	(Usage: hexadecimal)

hexcolor
	This validates that a string value contains a valid hex color including
	hashtag (#)
	(Usage: hexcolor)

rgb
	This validates that a string value contains a valid rgb color
	(Usage: rgb)

rgba
	This validates that a string value contains a valid rgba color
	(Usage: rgba)

hsl
	This validates that a string value contains a valid hsl color
	(Usage: hsl)

hsla
	This validates that a string value contains a valid hsla color
	(Usage: hsla)

email
	This validates that a string value contains a valid email
	This may not conform to all possibilities of any rfc standard, but neither
	does any email provider accept all posibilities...
	(Usage: email)

url
	This validates that a string value contains a valid url
	This will accept any url the golang request uri accepts but must contain
	a schema for example http:// or rtmp://
	(Usage: url)

uri
	This validates that a string value contains a valid uri
	This will accept any uri the golang request uri accepts (Usage: uri)

base64
	This validates that a string value contains a valid base64 value.
	Although an empty string is valid base64 this will report an empty string
	as an error, if you wish to accept an empty string as valid you can use
	this with the omitempty tag. (Usage: base64)

contains
	This validates that a string value contains the substring value.
	(Usage: contains=@)

containsany
	This validates that a string value contains any Unicode code points
	in the substring value. (Usage: containsany=!@#?)

containsrune
	This validates that a string value contains the supplied rune value.
	(Usage: containsrune=@)

excludes
	This validates that a string value does not contain the substring value.
	(Usage: excludes=@)

excludesall
	This validates that a string value does not contain any Unicode code
	points in the substring value. (Usage: excludesall=!@#?)

excludesrune
	This validates that a string value does not contain the supplied rune value.
	(Usage: excludesrune=@)

isbn
	This validates that a string value contains a valid isbn10 or isbn13 value.
	(Usage: isbn)

isbn10
	This validates that a string value contains a valid isbn10 value.
	(Usage: isbn10)

isbn13
	This validates that a string value contains a valid isbn13 value.
	(Usage: isbn13)

uuid
	This validates that a string value contains a valid UUID.
	(Usage: uuid)

uuid3
	This validates that a string value contains a valid version 3 UUID.
	(Usage: uuid3)

uuid4
	This validates that a string value contains a valid version 4 UUID.
	(Usage: uuid4)

uuid5
	This validates that a string value contains a valid version 5 UUID.
	(Usage: uuid5)

ascii
	This validates that a string value contains only ASCII characters.
	NOTE: if the string is blank, this validates as true.
	(Usage: ascii)

asciiprint
	This validates that a string value contains only printable ASCII characters.
	NOTE: if the string is blank, this validates as true.
	(Usage: asciiprint)

multibyte
	This validates that a string value contains one or more multibyte characters.
	NOTE: if the string is blank, this validates as true.
	(Usage: multibyte)

datauri
	This validates that a string value contains a valid DataURI.
	NOTE: this will also validate that the data portion is valid base64
	(Usage: datauri)

latitude
	This validates that a string value contains a valid latitude.
	(Usage: latitude)

longitude
	This validates that a string value contains a valid longitude.
	(Usage: longitude)

ssn
	This validates that a string value contains a valid U.S. Social Security Number.
	(Usage: ssn)

Validator notes:

regex
	a regex validator won't be added because commas and = signs can be part of
	a regex which conflict with the validation definitions, although workarounds
	can be made, they take away from using pure regex's. Furthermore it's quick
	and dirty but the regex's become harder to maintain and are not reusable, so
	it's as much a programming philosiphy as anything.

	In place of this new validator functions should be created; a regex can be
	used within the validator function and even be precompiled for better efficiency
	within regexes.go.

	And the best reason, you can submit a pull request and we can keep on adding to the
	validation library of this package!

Panics

This package panics when bad input is provided, this is by design, bad code like that should not make it to production.

type Test struct {
	TestField string `validate:"nonexistantfunction=1"`
}

t := &Test{
	TestField: "Test"
}

validate.Struct(t) // this will panic

Index

Examples

Constants

This section is empty.

Variables

View Source
var BakedInValidators = map[string]Func{
	"required":     hasValue,
	"len":          hasLengthOf,
	"min":          hasMinOf,
	"max":          hasMaxOf,
	"eq":           isEq,
	"ne":           isNe,
	"lt":           isLt,
	"lte":          isLte,
	"gt":           isGt,
	"gte":          isGte,
	"eqfield":      isEqField,
	"nefield":      isNeField,
	"gtefield":     isGteField,
	"gtfield":      isGtField,
	"ltefield":     isLteField,
	"ltfield":      isLtField,
	"alpha":        isAlpha,
	"alphanum":     isAlphanum,
	"numeric":      isNumeric,
	"number":       isNumber,
	"hexadecimal":  isHexadecimal,
	"hexcolor":     isHexcolor,
	"rgb":          isRgb,
	"rgba":         isRgba,
	"hsl":          isHsl,
	"hsla":         isHsla,
	"email":        isEmail,
	"url":          isURL,
	"uri":          isURI,
	"base64":       isBase64,
	"contains":     contains,
	"containsany":  containsAny,
	"containsrune": containsRune,
	"excludes":     excludes,
	"excludesall":  excludesAll,
	"excludesrune": excludesRune,
	"isbn":         isISBN,
	"isbn10":       isISBN10,
	"isbn13":       isISBN13,
	"uuid":         isUUID,
	"uuid3":        isUUID3,
	"uuid4":        isUUID4,
	"uuid5":        isUUID5,
	"ascii":        isASCII,
	"printascii":   isPrintableASCII,
	"multibyte":    hasMultiByteCharacter,
	"datauri":      isDataURI,
	"latitude":     isLatitude,
	"longitude":    isLongitude,
	"ssn":          isSSN,
}

BakedInValidators is the default map of ValidationFunc you can add, remove or even replace items to suite your needs, or even disregard and use your own map if so desired.

Functions

This section is empty.

Types

type FieldError

type FieldError struct {
	Field            string
	Tag              string
	Kind             reflect.Kind
	Type             reflect.Type
	Param            string
	Value            interface{}
	IsPlaceholderErr bool
	IsSliceOrArray   bool
	IsMap            bool
	SliceOrArrayErrs map[int]error         // counld be FieldError, StructErrors
	MapErrs          map[interface{}]error // counld be FieldError, StructErrors
}

FieldError contains a single field's validation error along with other properties that may be needed for error message creation

func (*FieldError) Error

func (e *FieldError) Error() string

This is intended for use in development + debugging and not intended to be a production error message. it also allows FieldError to be used as an Error interface

func (*FieldError) Flatten

func (e *FieldError) Flatten() map[string]*FieldError

Flatten flattens the FieldError hierarchical structure into a flat namespace style field name for those that want/need it. This is now needed because of the new dive functionality

type Func

type Func func(top interface{}, current interface{}, f interface{}, param string) bool

Func accepts all values needed for file and cross field validation top = top level struct when validating by struct otherwise nil current = current level struct when validating by struct otherwise optional comparison value f = field value for validation param = parameter used in validation i.e. gt=0 param would be 0

type StructErrors

type StructErrors struct {
	// Name of the Struct
	Struct string
	// Struct Field Errors
	Errors map[string]*FieldError
	// Struct Fields of type struct and their errors
	// key = Field Name of current struct, but internally Struct will be the actual struct name unless anonymous struct, it will be blank
	StructErrors map[string]*StructErrors
}

StructErrors is hierarchical list of field and struct validation errors for a non hierarchical representation please see the Flatten method for StructErrors

func (*StructErrors) Error

func (e *StructErrors) Error() string

This is intended for use in development + debugging and not intended to be a production error message. it also allows StructErrors to be used as an Error interface

func (*StructErrors) Flatten

func (e *StructErrors) Flatten() map[string]*FieldError

Flatten flattens the StructErrors hierarchical structure into a flat namespace style field name for those that want/need it

type Validate

type Validate struct {
	// contains filtered or unexported fields
}

Validate implements the Validate Struct NOTE: Fields within are not thread safe and that is on purpose Functions and Tags should all be predifined before use, so subscribe to the philosiphy or make it thread safe on your end

Example (AddFunction)
package main

import (
	"fmt"

	"../validator"
)

func main() {
	// This should be stored somewhere globally
	var validate *validator.Validate

	validate = validator.New("validate", validator.BakedInValidators)

	fn := func(top interface{}, current interface{}, field interface{}, param string) bool {
		return field.(string) == "hello"
	}

	validate.AddFunction("valueishello", fn)

	message := "hello"
	err := validate.Field(message, "valueishello")
	fmt.Println(err)
}
Output:

<nil>
Example (Field)
package main

import (
	"fmt"

	"../validator"
)

func main() {
	// This should be stored somewhere globally
	var validate *validator.Validate

	validate = validator.New("validate", validator.BakedInValidators)

	i := 0
	err := validate.Field(i, "gt=1,lte=10")
	fmt.Println(err.Field)
	fmt.Println(err.Tag)
	fmt.Println(err.Kind) // NOTE: Kind and Type can be different i.e. time Kind=struct and Type=time.Time
	fmt.Println(err.Type)
	fmt.Println(err.Param)
	fmt.Println(err.Value)
}
Output:


gt
int
int
1
0
Example (New)
package main

import (
	"../validator"
)

func main() {
	validator.New("validate", validator.BakedInValidators)
}
Output:

Example (Struct)
package main

import (
	"fmt"

	"../validator"
)

func main() {
	// This should be stored somewhere globally
	var validate *validator.Validate

	validate = validator.New("validate", validator.BakedInValidators)

	type ContactInformation struct {
		Phone  string `validate:"required"`
		Street string `validate:"required"`
		City   string `validate:"required"`
	}

	type User struct {
		Name               string `validate:"required,excludesall=!@#$%^&*()_+-=:;?/0x2C"` // 0x2C = comma (,)
		Age                int8   `validate:"required,gt=0,lt=150"`
		Email              string `validate:"email"`
		ContactInformation []*ContactInformation
	}

	contactInfo := &ContactInformation{
		Street: "26 Here Blvd.",
		City:   "Paradeso",
	}

	user := &User{
		Name:               "Joey Bloggs",
		Age:                31,
		Email:              "joeybloggs@gmail.com",
		ContactInformation: []*ContactInformation{contactInfo},
	}

	structError := validate.Struct(user)
	for _, fieldError := range structError.Errors {
		fmt.Println(fieldError.Field) // Phone
		fmt.Println(fieldError.Tag)   // required
		//... and so forth
		
Output:

func New

func New(tagName string, funcs map[string]Func) *Validate

New creates a new Validate instance for use.

func (*Validate) AddFunction

func (v *Validate) AddFunction(key string, f Func) error

AddFunction adds a validation Func to a Validate's map of validators denoted by the key NOTE: if the key already exists, it will get replaced. NOTE: this method is not thread-safe

func (*Validate) Field

func (v *Validate) Field(f interface{}, tag string) *FieldError

Field allows validation of a single field, still using tag style validation to check multiple errors

func (*Validate) FieldWithValue

func (v *Validate) FieldWithValue(val interface{}, f interface{}, tag string) *FieldError

FieldWithValue allows validation of a single field, possibly even against another fields value, still using tag style validation to check multiple errors

func (*Validate) SetMaxStructPoolSize

func (v *Validate) SetMaxStructPoolSize(max int)

SetMaxStructPoolSize sets the struct pools max size. this may be usefull for fine grained performance tuning towards your application, however, the default should be fine for nearly all cases. only increase if you have a deeply nested struct structure. NOTE: this method is not thread-safe NOTE: this is only here to keep compatibility with v5, in v6 the method will be removed

func (*Validate) SetTag

func (v *Validate) SetTag(tagName string)

SetTag sets tagName of the Validator to one of your choosing after creation perhaps to dodge a tag name conflict in a specific section of code NOTE: this method is not thread-safe

func (*Validate) Struct

func (v *Validate) Struct(s interface{}) *StructErrors

Struct validates a struct, even it's nested structs, and returns a struct containing the errors NOTE: Nested Arrays, or Maps of structs do not get validated only the Array or Map itself; the reason is that there is no good way to represent or report which struct within the array has the error, besides can validate the struct prior to adding it to the Array or Map.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL