import "github.com/asaskevich/govalidator"
Package govalidator is package of validators and sanitizers for strings, structs and collections.
arrays.go converter.go error.go numerics.go patterns.go types.go utils.go validator.go
const (
Email string = "" /* 1210 byte string literal not displayed */
CreditCard string = "" /* 153 byte string literal not displayed */
ISBN10 string = "^(?:[0-9]{9}X|[0-9]{10})$"
ISBN13 string = "^(?:[0-9]{13})$"
UUID3 string = "^[0-9a-f]{8}-[0-9a-f]{4}-3[0-9a-f]{3}-[0-9a-f]{4}-[0-9a-f]{12}$"
UUID4 string = "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
UUID5 string = "^[0-9a-f]{8}-[0-9a-f]{4}-5[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
UUID string = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
Alpha string = "^[a-zA-Z]+$"
Alphanumeric string = "^[a-zA-Z0-9]+$"
Numeric string = "^[0-9]+$"
Int string = "^(?:[-+]?(?:0|[1-9][0-9]*))$"
Float string = "^(?:[-+]?(?:[0-9]+))?(?:\\.[0-9]*)?(?:[eE][\\+\\-]?(?:[0-9]+))?$"
Hexadecimal string = "^[0-9a-fA-F]+$"
Hexcolor string = "^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$"
RGBcolor string = "" /* 159 byte string literal not displayed */
ASCII string = "^[\x00-\x7F]+$"
Multibyte string = "[^\x00-\x7F]"
FullWidth string = "[^\u0020-\u007E\uFF61-\uFF9F\uFFA0-\uFFDC\uFFE8-\uFFEE0-9a-zA-Z]"
HalfWidth string = "[\u0020-\u007E\uFF61-\uFF9F\uFFA0-\uFFDC\uFFE8-\uFFEE0-9a-zA-Z]"
Base64 string = "^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=|[A-Za-z0-9+\\/]{4})$"
PrintableASCII string = "^[\x20-\x7E]+$"
DataURI string = "^data:.+\\/(.+);base64$"
Latitude string = "^[-+]?([1-8]?\\d(\\.\\d+)?|90(\\.0+)?)$"
Longitude string = "^[-+]?(180(\\.0+)?|((1[0-7]\\d)|([1-9]?\\d))(\\.\\d+)?)$"
DNSName string = `^([a-zA-Z0-9_]{1}[a-zA-Z0-9_-]{0,62}){1}(\.[a-zA-Z0-9_]{1}[a-zA-Z0-9_-]{0,62})*[\._]?$`
IP string = "" /* 661 byte string literal not displayed */
URLSchema string = `((ftp|tcp|udp|wss?|https?):\/\/)`
URLUsername string = `(\S+(:\S*)?@)`
URLPath string = `((\/|\?|#)[^\s]*)`
URLPort string = `(:(\d{1,5}))`
URLIP string = `([1-9]\d?|1\d\d|2[01]\d|22[0-3])(\.(1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.([0-9]\d?|1\d\d|2[0-4]\d|25[0-4]))`
URLSubdomain string = `((www\.)|([a-zA-Z0-9]+([-_\.]?[a-zA-Z0-9])*[a-zA-Z0-9]\.[a-zA-Z0-9]+))`
URL string = `^` + URLSchema + `?` + URLUsername + `?` + `((` + URLIP + `|(\[` + IP + `\])|(([a-zA-Z0-9]([a-zA-Z0-9-_]+)?[a-zA-Z0-9]([-\.][a-zA-Z0-9]+)*)|(` + URLSubdomain + `?))?(([a-zA-Z\x{00a1}-\x{ffff}0-9]+-?-?)*[a-zA-Z\x{00a1}-\x{ffff}0-9]+)(?:\.([a-zA-Z\x{00a1}-\x{ffff}]{1,}))?))\.?` + URLPort + `?` + URLPath + `?$`
SSN string = `^\d{3}[- ]?\d{2}[- ]?\d{4}$`
WinPath string = `^[a-zA-Z]:\\(?:[^\\/:*?"<>|\r\n]+\\)*[^\\/:*?"<>|\r\n]*$`
UnixPath string = `^(/[^/\x00]*)+/?$`
Semver string = "" /* 185 byte string literal not displayed */
)Basic regular expressions for validating strings
const (
// Unknown is unresolved OS type
Unknown = iota
// Win is Windows type
Win
// Unix is *nix OS types
Unix
)Used by IsFilePath func
const RF3339WithoutZone = "2006-01-02T15:04:05"var CustomTypeTagMap = &customTypeTagMap{validators: make(map[string]CustomTypeValidator)}
CustomTypeTagMap is a map of functions that can be used as tags for ValidateStruct function. Use this to validate compound or custom types that need to be handled as a whole, e.g. `type UUID [16]byte` (this would be handled as an array of bytes).
var Escape = html.EscapeString
Escape replace <, >, & and " with HTML entities.
var ISO3166List = []ISO3166Entry{ /* 249 elements not displayed */ }
ISO3166List based on https://www.iso.org/obp/ui/#search/code/ Code Type "Officially Assigned Codes"
ISO4217List is the list of ISO currency codes
var ISO693List = []ISO693Entry{ /* 184 elements not displayed */ }
ISO693List based on http://data.okfn.org/data/core/language-codes/r/language-codes-3b2.json
var ParamTagMap = map[string]ParamValidator{ "length": ByteLength, "range": Range, "runelength": RuneLength, "stringlength": StringLength, "matches": StringMatches, "in": isInRaw, "rsapub": IsRsaPub, }
ParamTagMap is a map of functions accept variants parameters
var ParamTagRegexMap = map[string]*regexp.Regexp{ "range": regexp.MustCompile("^range\\((\\d+)\\|(\\d+)\\)$"), "length": regexp.MustCompile("^length\\((\\d+)\\|(\\d+)\\)$"), "runelength": regexp.MustCompile("^runelength\\((\\d+)\\|(\\d+)\\)$"), "stringlength": regexp.MustCompile("^stringlength\\((\\d+)\\|(\\d+)\\)$"), "in": regexp.MustCompile(`^in\((.*)\)`), "matches": regexp.MustCompile(`^matches\((.+)\)$`), "rsapub": regexp.MustCompile("^rsapub\\((\\d+)\\)$"), }
ParamTagRegexMap maps param tags to their respective regexes.
var TagMap = map[string]Validator{ "email": IsEmail, "url": IsURL, "dialstring": IsDialString, "requrl": IsRequestURL, "requri": IsRequestURI, "alpha": IsAlpha, "utfletter": IsUTFLetter, "alphanum": IsAlphanumeric, "utfletternum": IsUTFLetterNumeric, "numeric": IsNumeric, "utfnumeric": IsUTFNumeric, "utfdigit": IsUTFDigit, "hexadecimal": IsHexadecimal, "hexcolor": IsHexcolor, "rgbcolor": IsRGBcolor, "lowercase": IsLowerCase, "uppercase": IsUpperCase, "int": IsInt, "float": IsFloat, "null": IsNull, "uuid": IsUUID, "uuidv3": IsUUIDv3, "uuidv4": IsUUIDv4, "uuidv5": IsUUIDv5, "creditcard": IsCreditCard, "isbn10": IsISBN10, "isbn13": IsISBN13, "json": IsJSON, "multibyte": IsMultibyte, "ascii": IsASCII, "printableascii": IsPrintableASCII, "fullwidth": IsFullWidth, "halfwidth": IsHalfWidth, "variablewidth": IsVariableWidth, "base64": IsBase64, "datauri": IsDataURI, "ip": IsIP, "port": IsPort, "ipv4": IsIPv4, "ipv6": IsIPv6, "dns": IsDNSName, "host": IsHost, "mac": IsMAC, "latitude": IsLatitude, "longitude": IsLongitude, "ssn": IsSSN, "semver": IsSemver, "rfc3339": IsRFC3339, "rfc3339WithoutZone": IsRFC3339WithoutZone, "ISO3166Alpha2": IsISO3166Alpha2, "ISO3166Alpha3": IsISO3166Alpha3, "ISO4217": IsISO4217, }
TagMap is a map of functions, that can be used as tags for ValidateStruct function.
Abs returns absolute value of number
BlackList remove characters that appear in the blacklist.
ByteLength check string's length
CamelCaseToUnderscore converts from camel case form to underscore separated form. Ex.: MyFunc => my_func
Contains check if the string contains the substring.
func Count(array []interface{}, iterator ConditionIterator) intCount iterates over the slice and apply ConditionIterator to every item. Returns count of items that meets ConditionIterator.
Code:
data := []interface{}{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}
var fn ConditionIterator = func(value interface{}, index int) bool {
return value.(int)%2 == 0
}
_ = Count(data, fn) // result = 5
Each iterates over the slice and apply Iterator to every item
Code:
data := []interface{}{1, 2, 3, 4, 5}
var fn Iterator = func(value interface{}, index int) {
println(value.(int))
}
Each(data, fn)
ErrorByField returns error for specified field of the struct validated by ValidateStruct or empty string if there are no errors or this field doesn't exists or doesn't have any errors.
ErrorsByField returns map of errors of the struct validated by ValidateStruct or empty map if there are no errors.
func Filter(array []interface{}, iterator ConditionIterator) []interface{}Filter iterates over the slice and apply ConditionIterator to every item. Returns new slice.
Code:
data := []interface{}{1, 2, 3, 4, 5, 6, 7, 8, 9, 10}
var fn ConditionIterator = func(value interface{}, index int) bool {
return value.(int)%2 == 0
}
_ = Filter(data, fn) // result = []interface{}{2, 4, 6, 8, 10}
func Find(array []interface{}, iterator ConditionIterator) interface{}Find iterates over the slice and apply ConditionIterator to every item. Returns first item that meet ConditionIterator or nil otherwise.
GetLine return specified line of multiline string
GetLines split string by "\n" and return array of lines
HasLowerCase check if the string contains at least 1 lowercase. Empty string is valid.
HasUpperCase check if the string contians as least 1 uppercase. Empty string is valid.
HasWhitespace checks if the string contains any whitespace
HasWhitespaceOnly checks the string only contains whitespace
InRange returns true if value lies between left and right border, generic type to handle int, float32 or float64, all types must the same type
InRange returns true if value lies between left and right border
InRange returns true if value lies between left and right border
InRange returns true if value lies between left and right border
IsASCII check if the string contains ASCII chars only. Empty string is valid.
IsAlpha check if the string contains only letters (a-zA-Z). Empty string is valid.
IsAlphanumeric check if the string contains only letters and numbers. Empty string is valid.
IsBase64 check if a string is base64 encoded.
IsByteLength check if the string's length (in bytes) falls in a range.
IsCIDR check if the string is an valid CIDR notiation (IPV4 & IPV6)
IsCreditCard check if the string is a credit card.
IsDNSName will validate the given string as a DNS name
IsDataURI checks if a string is base64 encoded data URI such as an image
IsDialString validates the given string for usage with the various Dial() functions
IsDivisibleBy check if the string is a number that's divisible by another. If second argument is not valid integer or zero, it's return false. Otherwise, if first argument is not valid integer or zero, it's return true (Invalid string converts to zero).
This small example illustrate how to work with IsDivisibleBy function.
Code:
println("1024 is divisible by 64: ", IsDivisibleBy("1024", "64"))
IsEmail check if the string is an email.
IsExistingEmail check if the string is an email of existing domain
IsFilePath check is a string is Win or Unix file path and returns it's type.
IsFloat check if the string is a float.
IsFullWidth check if the string contains any full-width chars. Empty string is valid.
IsHalfWidth check if the string contains any half-width chars. Empty string is valid.
IsHash checks if a string is a hash of type algorithm. Algorithm is one of ['md4', 'md5', 'sha1', 'sha256', 'sha384', 'sha512', 'ripemd128', 'ripemd160', 'tiger128', 'tiger160', 'tiger192', 'crc32', 'crc32b']
IsHexadecimal check if the string is a hexadecimal number.
IsHexcolor check if the string is a hexadecimal color.
IsHost checks if the string is a valid IP (both v4 and v6) or a valid DNS name
IsIP checks if a string is either IP version 4 or 6.
IsIPv4 check if the string is an IP version 4.
IsIPv6 check if the string is an IP version 6.
IsISBN check if the string is an ISBN (version 10 or 13). If version value is not equal to 10 or 13, it will be check both variants.
IsISBN10 check if the string is an ISBN version 10.
IsISBN13 check if the string is an ISBN version 13.
IsISO3166Alpha2 checks if a string is valid two-letter country code
IsISO3166Alpha3 checks if a string is valid three-letter country code
IsISO4217 check if string is valid ISO currency code
IsISO693Alpha2 checks if a string is valid two-letter language code
IsISO693Alpha3b checks if a string is valid three-letter language code
IsIn check if string str is a member of the set of strings params
IsInt check if the string is an integer. Empty string is valid.
IsJSON check if the string is valid JSON (note: uses json.Unmarshal).
IsLatitude check if a string is valid latitude.
IsLongitude check if a string is valid longitude.
IsLowerCase check if the string is lowercase. Empty string is valid.
IsMAC check if a string is valid MAC address. Possible MAC formats: 01:23:45:67:89:ab 01:23:45:67:89:ab:cd:ef 01-23-45-67-89-ab 01-23-45-67-89-ab-cd-ef 0123.4567.89ab 0123.4567.89ab.cdef
IsMongoID check if the string is a valid hex-encoded representation of a MongoDB ObjectId.
IsMultibyte check if the string contains one or more multibyte chars. Empty string is valid.
IsNatural returns true if value is natural number (positive and whole)
IsNegative returns true if value < 0
IsNonNegative returns true if value >= 0
IsNonPositive returns true if value <= 0
IsNull check if the string is null.
IsNumeric check if the string contains only numbers. Empty string is valid.
IsPort checks if a string represents a valid port
IsPositive returns true if value > 0
IsPrintableASCII check if the string contains printable ASCII chars only. Empty string is valid.
IsRFC3339 check if string is valid timestamp value according to RFC3339
IsRFC3339WithoutZone check if string is valid timestamp value according to RFC3339 which excludes the timezone.
IsRGBcolor check if the string is a valid RGB color in form rgb(RRR, GGG, BBB).
IsRequestURI check if the string rawurl, assuming it was received in an HTTP request, is an absolute URI or an absolute path.
IsRequestURL check if the string rawurl, assuming it was received in an HTTP request, is a valid URL confirm to RFC 3986
IsRsaPub check whether string is valid RSA key Alias for IsRsaPublicKey
IsRsaPublicKey check if a string is valid public key with provided length
IsSSN will validate the given string as a U.S. Social Security Number
IsSemver check if string is valid semantic version
IsTime check if string is valid according to given format
IsURL check if the string is an URL.
IsUTFDigit check if the string contains only unicode radix-10 decimal digits. Empty string is valid.
IsUTFLetter check if the string contains only unicode letter characters. Similar to IsAlpha but for all languages. Empty string is valid.
IsUTFLetterNumeric check if the string contains only unicode letters and numbers. Empty string is valid.
IsUTFNumeric check if the string contains only unicode numbers of any kind. Numbers can be 0-9 but also Fractions ¾,Roman Ⅸ and Hangzhou 〩. Empty string is valid.
IsUUID check if the string is a UUID (version 3, 4 or 5).
IsUUIDv3 check if the string is a UUID version 3.
IsUUIDv4 check if the string is a UUID version 4.
IsUUIDv5 check if the string is a UUID version 5.
IsUpperCase check if the string is uppercase. Empty string is valid.
IsVariableWidth check if the string contains a mixture of full and half-width chars. Empty string is valid.
IsWhole returns true if value is whole number
LeftTrim trim characters from the left-side of the input. If second argument is empty, it's will be remove leading spaces.
func Map(array []interface{}, iterator ResultIterator) []interface{}Map iterates over the slice and apply ResultIterator to every item. Returns new slice as a result.
Code:
data := []interface{}{1, 2, 3, 4, 5}
var fn ResultIterator = func(value interface{}, index int) interface{} {
return value.(int) * 3
}
_ = Map(data, fn) // result = []interface{}{1, 6, 9, 12, 15}
Matches check if string matches the pattern (pattern is regular expression) In case of error return false
NormalizeEmail canonicalize an email address. The local part of the email address is lowercased for all domains; the hostname is always lowercased and the local part of the email address is always lowercased for hosts that are known to be case-insensitive (currently only GMail). Normalization follows special rules for known providers: currently, GMail addresses have dots removed in the local part and are stripped of tags (e.g. some.one+tag@gmail.com becomes someone@gmail.com) and all @googlemail.com addresses are normalized to @gmail.com.
PadBoth pad sides of string if size of string is less then indicated pad length
PadLeft pad left side of string if size of string is less then indicated pad length
PadRight pad right side of string if size of string is less then indicated pad length
Range check string's length
RemoveTags remove all tags from HTML string
ReplacePattern replace regular expression pattern in string
This small example illustrate how to work with ReplacePattern function.
Code:
// Replace in "http123123ftp://git534543hub.comio" following (pattern "(ftp|io|[0-9]+)"):
// - Sequence "ftp".
// - Sequence "io".
// - Sequence of digits.
// with empty string.
println(ReplacePattern("http123123ftp://git534543hub.comio", "(ftp|io|[0-9]+)", "") == "http://github.com")
Reverse return reversed string
RightTrim trim characters from the right-side of the input. If second argument is empty, it's will be remove spaces.
RuneLength check string's length Alias for StringLength
SafeFileName return safe string that can be used in file names
SetFieldsRequiredByDefault causes validation to fail when struct fields do not include validations or are not explicitly marked as exempt (using `valid:"-"` or `valid:"email,optional"`). This struct definition will fail govalidator.ValidateStruct() (and the field values do not matter):
type exampleStruct struct {
Name string ``
Email string `valid:"email"`
This, however, will only fail when Email is empty or an invalid email address:
type exampleStruct2 struct {
Name string `valid:"-"`
Email string `valid:"email"`
Lastly, this will only fail when Email is an invalid email address but not when it's empty:
type exampleStruct2 struct {
Name string `valid:"-"`
Email string `valid:"email,optional"`
SetNilPtrAllowedByRequired causes validation to pass for nil ptrs when a field is set to required. The validation will still reject ptr fields in their zero value state. Example with this enabled:
type exampleStruct struct {
Name *string `valid:"required"`
With `Name` set to "", this will be considered invalid input and will cause a validation error. With `Name` set to nil, this will be considered valid by validation. By default this is disabled.
Sign returns signum of number: 1 in case of value > 0, -1 in case of value < 0, 0 otherwise
StringLength check string's length (including multi byte strings)
StringMatches checks if a string matches a given pattern.
StripLow remove characters with a numerical value < 32 and 127, mostly control characters. If keep_new_lines is true, newline characters are preserved (\n and \r, hex 0xA and 0xD).
ToBoolean convert the input string to a boolean.
ToFloat convert the input string to a float, or 0.0 if the input is not a float.
ToInt convert the input string or any int type to an integer type 64, or 0 if the input is not an integer.
ToJSON convert the input to a valid JSON string
ToString convert the input to a string.
Trim trim characters from both sides of the input. If second argument is empty, it's will be remove spaces.
This small example illustrate how to work with Trim function.
Code:
// Remove from left and right spaces and "\r", "\n", "\t" characters println(Trim(" \r\r\ntext\r \t\n", "") == "text") // Remove from left and right characters that are between "1" and "8". // "1-8" is like full list "12345678". println(Trim("1234567890987654321", "1-8") == "909")
Truncate a string to the closest length without breaking words.
TruncatingErrorf removes extra args from fmt.Errorf if not formatted in the str object
UnderscoreToCamelCase converts from underscore separated form to camel case form. Ex.: my_func => MyFunc
ValidateStruct use tags for fields. result will be equal to `false` if there are any errors.
Code:
type Post struct {
Title string `valid:"alphanum,required"`
Message string `valid:"duck,ascii"`
AuthorIP string `valid:"ipv4"`
}
post := &Post{"My Example Post", "duck", "123.234.54.3"}
//Add your own struct validation tags
TagMap["duck"] = Validator(func(str string) bool {
return str == "duck"
})
result, err := ValidateStruct(post)
if err != nil {
println("error: " + err.Error())
}
println(result)
WhiteList remove characters that do not appear in the whitelist.
This small example illustrate how to work with WhiteList function.
Code:
// Remove all characters from string ignoring characters between "a" and "z"
println(WhiteList("a3a43a5a4a3a2a23a4a5a4a3a4", "a-z") == "aaaaaaaaaaaa")
ConditionIterator is the function that accepts element of slice/array and its index and returns boolean
CustomTypeValidator is a wrapper for validator functions that returns bool and accepts any type. The second parameter should be the context (in the case of validating a struct: the whole object being validated).
type Error struct {
Name string
Err error
CustomErrorMessageExists bool
// Validator indicates the name of the validator that failed
Validator string
Path []string
}Error encapsulates a name, an error and whether there's a custom error message or not.
Errors is an array of multiple errors and conforms to the error interface.
Errors returns itself.
type ISO3166Entry struct {
EnglishShortName string
FrenchShortName string
Alpha2Code string
Alpha3Code string
Numeric string
}ISO3166Entry stores country codes
ISO693Entry stores ISO language codes
Iterator is the function that accepts element of slice/array and its index
ParamValidator is a wrapper for validator functions that accepts additional parameters.
ResultIterator is the function that accepts element of slice/array and its index and returns any result
UnsupportedTypeError is a wrapper for reflect.Type
func (e *UnsupportedTypeError) Error() string
Error returns string equivalent for reflect.Type
Validator is a wrapper for a validator function that returns bool and accepts string.
Package govalidator imports 23 packages (graph) and is imported by 639 packages. Updated 2019-07-04. Refresh now. Tools for package owners.