builtin

type Rule ¶

type Rule interface {
	// Name returns the builtin name of the rule.
	Name() string

	// Message returns the default error message of the rule.
	Message() string

	// Run starts running the rule, it returns nil if successful, or else an error.
	Run(in RunInput) error
}

func GetRule(name string) Rule

type RuleAfter ¶

type RuleAfter struct{}

RuleAfter implements `after` rule: The datetime value should be after the value of field `field`.

Format: after:field

func (r RuleAfter) Message() string

func (r RuleAfter) Name() string

func (r RuleAfter) Run(in RunInput) error

type RuleAfterEqual ¶

type RuleAfterEqual struct{}

RuleAfterEqual implements `after-equal` rule: The datetime value should be after or equal to the value of field `field`.

Format: after-equal:field

func (r RuleAfterEqual) Message() string

func (r RuleAfterEqual) Name() string

func (r RuleAfterEqual) Run(in RunInput) error

type RuleArray ¶

type RuleArray struct{}

RuleArray implements `array` rule: Value should be type of array.

Format: array

func (r RuleArray) Message() string

func (r RuleArray) Name() string

func (r RuleArray) Run(in RunInput) error

type RuleBail ¶

type RuleBail struct{}

RuleBail implements `bail` rule: Stop validating when this field's validation failed.

Format: bail

func (r RuleBail) Message() string

func (r RuleBail) Name() string

func (r RuleBail) Run(in RunInput) error

type RuleBankCard ¶

type RuleBankCard struct{}

RuleBankCard implements `bank-card` rule: Bank card number.

Format: bank-card

func (r RuleBankCard) Message() string

func (r RuleBankCard) Name() string

func (r RuleBankCard) Run(in RunInput) error

type RuleBefore ¶

type RuleBefore struct{}

RuleBefore implements `before` rule: The datetime value should be after the value of field `field`.

Format: before:field

func (r RuleBefore) Message() string

func (r RuleBefore) Name() string

func (r RuleBefore) Run(in RunInput) error

type RuleBeforeEqual ¶

type RuleBeforeEqual struct{}

RuleBeforeEqual implements `before-equal` rule: The datetime value should be after or equal to the value of field `field`.

Format: before-equal:field

func (r RuleBeforeEqual) Message() string

func (r RuleBeforeEqual) Name() string

func (r RuleBeforeEqual) Run(in RunInput) error

type RuleBetween ¶

type RuleBetween struct{}

RuleBetween implements `between` rule: Range between :min and :max. It supports both integer and float.

Format: between:min,max

func (r RuleBetween) Message() string

func (r RuleBetween) Name() string

func (r RuleBetween) Run(in RunInput) error

type RuleBoolean ¶

type RuleBoolean struct{}

RuleBoolean implements `boolean` rule: Boolean(1,true,on,yes:true | 0,false,off,no,"":false)

Format: boolean

func (r RuleBoolean) Message() string

func (r RuleBoolean) Name() string

func (r RuleBoolean) Run(in RunInput) error

type RuleCi ¶

type RuleCi struct{}

RuleCi implements `ci` rule: Case-Insensitive configuration for those rules that need value comparison like: same, different, in, not-in, etc.

Format: ci

func (r RuleCi) Message() string

func (r RuleCi) Name() string

func (r RuleCi) Run(in RunInput) error

type RuleDate ¶

type RuleDate struct{}

RuleDate implements `date` rule: Standard date, like: 2006-01-02, 20060102, 2006.01.02.

Format: date

func (r RuleDate) Message() string

func (r RuleDate) Name() string

func (r RuleDate) Run(in RunInput) error

type RuleDateFormat ¶

type RuleDateFormat struct{}

RuleDateFormat implements `date-format` rule: Custom date format.

Format: date-format:format

func (r RuleDateFormat) Message() string

func (r RuleDateFormat) Name() string

func (r RuleDateFormat) Run(in RunInput) error

type RuleDatetime ¶

type RuleDatetime struct{}

RuleDatetime implements `datetime` rule: Standard datetime, like: 2006-01-02 12:00:00.

Format: datetime

func (r RuleDatetime) Message() string

func (r RuleDatetime) Name() string

func (r RuleDatetime) Run(in RunInput) error

type RuleDifferent ¶

type RuleDifferent struct{}

RuleDifferent implements `different` rule: Value should be different from value of field.

Format: different:field

func (r RuleDifferent) Message() string

func (r RuleDifferent) Name() string

func (r RuleDifferent) Run(in RunInput) error

type RuleDomain ¶

type RuleDomain struct{}

RuleDomain implements `domain` rule: Domain.

Format: domain

func (r RuleDomain) Message() string

func (r RuleDomain) Name() string

func (r RuleDomain) Run(in RunInput) error

type RuleEmail ¶

type RuleEmail struct{}

RuleEmail implements `email` rule: Email address.

Format: email

func (r RuleEmail) Message() string

func (r RuleEmail) Name() string

func (r RuleEmail) Run(in RunInput) error

type RuleEnums ¶

type RuleEnums struct{}

RuleEnums implements `enums` rule: Value should be in enums of its constant type.

Format: enums

func (r RuleEnums) Message() string

func (r RuleEnums) Name() string

func (r RuleEnums) Run(in RunInput) error

type RuleEq ¶

type RuleEq struct{}

RuleEq implements `eq` rule: Value should be the same as value of field.

This rule performs the same as rule `same`.

Format: eq:field

func (r RuleEq) Message() string

func (r RuleEq) Name() string

func (r RuleEq) Run(in RunInput) error

type RuleFloat ¶

type RuleFloat struct{}

RuleFloat implements `float` rule: Float. Note that an integer is actually a float number.

Format: float

func (r RuleFloat) Message() string

func (r RuleFloat) Name() string

func (r RuleFloat) Run(in RunInput) error

type RuleForeach ¶

type RuleForeach struct{}

RuleForeach implements `foreach` rule: It tells the next validation using current value as an array and validates each of its element.

Format: foreach

func (r RuleForeach) Message() string

func (r RuleForeach) Name() string

func (r RuleForeach) Run(in RunInput) error

type RuleGT ¶

type RuleGT struct{}

RuleGT implements `gt` rule: Greater than `field`. It supports both integer and float.

Format: gt:field

func (r RuleGT) Message() string

func (r RuleGT) Name() string

func (r RuleGT) Run(in RunInput) error

type RuleGTE ¶

type RuleGTE struct{}

RuleGTE implements `gte` rule: Greater than or equal to `field`. It supports both integer and float.

Format: gte:field

func (r RuleGTE) Message() string

func (r RuleGTE) Name() string

func (r RuleGTE) Run(in RunInput) error

type RuleIn ¶

type RuleIn struct{}

RuleIn implements `in` rule: Value should be in: value1,value2,...

Format: in:value1,value2,...

func (r RuleIn) Message() string

func (r RuleIn) Name() string

func (r RuleIn) Run(in RunInput) error

type RuleInteger ¶

type RuleInteger struct{}

RuleInteger implements `integer` rule: Integer.

Format: integer

func (r RuleInteger) Message() string

func (r RuleInteger) Name() string

func (r RuleInteger) Run(in RunInput) error

type RuleIp ¶

type RuleIp struct{}

RuleIp implements `ip` rule: IPv4/IPv6.

Format: ip

func (r RuleIp) Message() string

func (r RuleIp) Name() string

func (r RuleIp) Run(in RunInput) error

type RuleIpv4 ¶

type RuleIpv4 struct{}

RuleIpv4 implements `ipv4` rule: IPv4.

Format: ipv4

func (r RuleIpv4) Message() string

func (r RuleIpv4) Name() string

func (r RuleIpv4) Run(in RunInput) error

type RuleIpv6 ¶

type RuleIpv6 struct{}

RuleIpv6 implements `ipv6` rule: IPv6.

Format: ipv6

func (r RuleIpv6) Message() string

func (r RuleIpv6) Name() string

func (r RuleIpv6) Run(in RunInput) error

type RuleJson ¶

type RuleJson struct{}

RuleJson implements `json` rule: JSON.

Format: json

func (r RuleJson) Message() string

func (r RuleJson) Name() string

func (r RuleJson) Run(in RunInput) error

type RuleLT ¶

type RuleLT struct{}

RuleLT implements `lt` rule: Lesser than `field`. It supports both integer and float.

Format: lt:field

func (r RuleLT) Message() string

func (r RuleLT) Name() string

func (r RuleLT) Run(in RunInput) error

type RuleLTE ¶

type RuleLTE struct{}

RuleLTE implements `lte` rule: Lesser than or equal to `field`. It supports both integer and float.

Format: lte:field

func (r RuleLTE) Message() string

func (r RuleLTE) Name() string

func (r RuleLTE) Run(in RunInput) error

type RuleLength ¶

type RuleLength struct{}

RuleLength implements `length` rule: Length between :min and :max. The length is calculated using unicode string, which means one chinese character or letter both has the length of 1.

Format: length:min,max

func (r RuleLength) Message() string

func (r RuleLength) Name() string

func (r RuleLength) Run(in RunInput) error

type RuleMac ¶

type RuleMac struct{}

RuleMac implements `mac` rule: MAC.

Format: mac

func (r RuleMac) Message() string

func (r RuleMac) Name() string

func (r RuleMac) Run(in RunInput) error

type RuleMax ¶

type RuleMax struct{}

RuleMax implements `max` rule: Equal or lesser than :max. It supports both integer and float.

Format: max:max

func (r RuleMax) Message() string

func (r RuleMax) Name() string

func (r RuleMax) Run(in RunInput) error

type RuleMaxLength ¶

type RuleMaxLength struct{}

RuleMaxLength implements `max-length` rule: Length is equal or lesser than :max. The length is calculated using unicode string, which means one chinese character or letter both has the length of 1.

Format: max-length:max

func (r RuleMaxLength) Message() string

func (r RuleMaxLength) Name() string

func (r RuleMaxLength) Run(in RunInput) error

type RuleMin ¶

type RuleMin struct{}

RuleMin implements `min` rule: Equal or greater than :min. It supports both integer and float.

Format: min:min

func (r RuleMin) Message() string

func (r RuleMin) Name() string

func (r RuleMin) Run(in RunInput) error

type RuleMinLength ¶

type RuleMinLength struct{}

RuleMinLength implements `min-length` rule: Length is equal or greater than :min. The length is calculated using unicode string, which means one chinese character or letter both has the length of 1.

Format: min-length:min

func (r RuleMinLength) Message() string

func (r RuleMinLength) Name() string

func (r RuleMinLength) Run(in RunInput) error

type RuleNotEq ¶

type RuleNotEq struct{}

RuleNotEq implements `not-eq` rule: Value should be different from value of field.

Format: not-eq:field

func (r RuleNotEq) Message() string

func (r RuleNotEq) Name() string

func (r RuleNotEq) Run(in RunInput) error

type RuleNotIn ¶

type RuleNotIn struct{}

RuleNotIn implements `not-in` rule: Value should not be in: value1,value2,...

Format: not-in:value1,value2,...

func (r RuleNotIn) Message() string

func (r RuleNotIn) Name() string

func (r RuleNotIn) Run(in RunInput) error

type RuleNotRegex ¶

type RuleNotRegex struct{}

RuleNotRegex implements `not-regex` rule: Value should not match custom regular expression pattern.

Format: not-regex:pattern

func (r RuleNotRegex) Message() string

func (r RuleNotRegex) Name() string

func (r RuleNotRegex) Run(in RunInput) error

type RulePassport ¶

type RulePassport struct{}

RulePassport implements `passport` rule: Universal passport format rule: Starting with letter, containing only numbers or underscores, length between 6 and 18

Format: passport

func (r RulePassport) Message() string

func (r RulePassport) Name() string

func (r RulePassport) Run(in RunInput) error

type RulePassword ¶

type RulePassword struct{}

RulePassword implements `password` rule: Universal password format rule1: Containing any visible chars, length between 6 and 18.

Format: password

func (r RulePassword) Message() string

func (r RulePassword) Name() string

func (r RulePassword) Run(in RunInput) error

type RulePassword2 ¶

type RulePassword2 struct{}

RulePassword2 implements `password2` rule: Universal password format rule2: Must meet password rule1, must contain lower and upper letters and numbers.

Format: password2

func (r RulePassword2) Message() string

func (r RulePassword2) Name() string

func (r RulePassword2) Run(in RunInput) error

type RulePassword3 ¶

type RulePassword3 struct{}

RulePassword3 implements `password3` rule: Universal password format rule3: Must meet password rule1, must contain lower and upper letters, numbers and special chars.

Format: password3

func (r RulePassword3) Message() string

func (r RulePassword3) Name() string

func (r RulePassword3) Run(in RunInput) error

type RulePhone ¶

type RulePhone struct{}

RulePhone implements `phone` rule:

1. China Mobile: 134, 135, 136, 137, 138, 139, 150, 151, 152, 157, 158, 159, 182, 183, 184, 187, 188, 178(4G), 147(Net)； 172

2. China Unicom: 130, 131, 132, 155, 156, 185, 186 ,176(4G), 145(Net), 175

3. China Telecom: 133, 153, 180, 181, 189, 177(4G)

4. Satelite: 1349

5. Virtual: 170, 173

6. 2018: 16x, 19x

Format: phone

func (r RulePhone) Message() string

func (r RulePhone) Name() string

func (r RulePhone) Run(in RunInput) error

type RulePhoneLoose ¶

type RulePhoneLoose struct{}

RulePhoneLoose implements `phone-loose` rule: Loose mobile phone number verification(宽松的手机号验证) As long as the 11 digits numbers beginning with 13, 14, 15, 16, 17, 18, 19 can pass the verification (只要满足 13、14、15、16、17、18、19开头的11位数字都可以通过验证).

Format: phone-loose

func (r RulePhoneLoose) Message() string

func (r RulePhoneLoose) Name() string

func (r RulePhoneLoose) Run(in RunInput) error

type RulePostcode ¶

type RulePostcode struct{}

RulePostcode implements `postcode` rule: Postcode number.

Format: postcode

func (r RulePostcode) Message() string

func (r RulePostcode) Name() string

func (r RulePostcode) Run(in RunInput) error

type RuleQQ ¶

type RuleQQ struct{}

RuleQQ implements `qq` rule: Tencent QQ number.

Format: qq

func (r RuleQQ) Message() string

func (r RuleQQ) Name() string

func (r RuleQQ) Run(in RunInput) error

type RuleRegex ¶

type RuleRegex struct{}

RuleRegex implements `regex` rule: Value should match custom regular expression pattern.

Format: regex:pattern

func (r RuleRegex) Message() string

func (r RuleRegex) Name() string

func (r RuleRegex) Run(in RunInput) error

type RuleRequired ¶

type RuleRequired struct{}

RuleRequired implements `required` rule. Format: required

func (r RuleRequired) Message() string

func (r RuleRequired) Name() string

func (r RuleRequired) Run(in RunInput) error

type RuleRequiredIf ¶

type RuleRequiredIf struct{}

RuleRequiredIf implements `required-if` rule: Required unless all given field and its value are equal.

Format: required-if:field,value,... Example: required-if: id,1,age,18

func (r RuleRequiredIf) Message() string

func (r RuleRequiredIf) Name() string

func (r RuleRequiredIf) Run(in RunInput) error

type RuleRequiredUnless ¶

type RuleRequiredUnless struct{}

RuleRequiredUnless implements `required-unless` rule: Required unless all given field and its value are not equal.

Format: required-unless:field,value,... Example: required-unless:id,1,age,18

func (r RuleRequiredUnless) Message() string

func (r RuleRequiredUnless) Name() string

func (r RuleRequiredUnless) Run(in RunInput) error

type RuleRequiredWith ¶

type RuleRequiredWith struct{}

RuleRequiredWith implements `required-with` rule: Required if any of given fields are not empty.

Format: required-with:field1,field2,... Example: required-with:id,name

func (r RuleRequiredWith) Message() string

func (r RuleRequiredWith) Name() string

func (r RuleRequiredWith) Run(in RunInput) error

type RuleRequiredWithAll ¶

type RuleRequiredWithAll struct{}

RuleRequiredWithAll implements `required-with-all` rule: Required if all given fields are not empty.

Format: required-with-all:field1,field2,... Example: required-with-all:id,name

func (r RuleRequiredWithAll) Message() string

func (r RuleRequiredWithAll) Name() string

func (r RuleRequiredWithAll) Run(in RunInput) error

type RuleRequiredWithout ¶

type RuleRequiredWithout struct{}

RuleRequiredWithout implements `required-without` rule: Required if any of given fields are empty.

Format: required-without:field1,field2,... Example: required-without:id,name

func (r RuleRequiredWithout) Message() string

func (r RuleRequiredWithout) Name() string

func (r RuleRequiredWithout) Run(in RunInput) error

type RuleRequiredWithoutAll ¶

type RuleRequiredWithoutAll struct{}

RuleRequiredWithoutAll implements `required-without-all` rule: Required if all given fields are empty.

Format: required-without-all:field1,field2,... Example: required-without-all:id,name

func (r RuleRequiredWithoutAll) Message() string

func (r RuleRequiredWithoutAll) Name() string

func (r RuleRequiredWithoutAll) Run(in RunInput) error

type RuleResidentId ¶

type RuleResidentId struct{}

RuleResidentId implements `resident-id` rule: Resident id number.

Format: resident-id

func (r RuleResidentId) Message() string

func (r RuleResidentId) Name() string

func (r RuleResidentId) Run(in RunInput) error

type RuleSame ¶

type RuleSame struct{}

RuleSame implements `same` rule: Value should be the same as value of field.

Format: same:field

func (r RuleSame) Message() string

func (r RuleSame) Name() string

func (r RuleSame) Run(in RunInput) error

type RuleSize ¶

type RuleSize struct{}

RuleSize implements `size` rule: Length must be :size. The length is calculated using unicode string, which means one chinese character or letter both has the length of 1.

Format: size:size

func (r RuleSize) Message() string

func (r RuleSize) Name() string

func (r RuleSize) Run(in RunInput) error

type RuleTelephone ¶

type RuleTelephone struct{}

RuleTelephone implements `telephone` rule: "XXXX-XXXXXXX" "XXXX-XXXXXXXX" "XXX-XXXXXXX" "XXX-XXXXXXXX" "XXXXXXX" "XXXXXXXX"

Format: telephone

func (r RuleTelephone) Message() string

func (r RuleTelephone) Name() string

func (r RuleTelephone) Run(in RunInput) error

type RuleUrl ¶

type RuleUrl struct{}

RuleUrl implements `url` rule: URL.

Format: url

func (r RuleUrl) Message() string

func (r RuleUrl) Name() string

func (r RuleUrl) Run(in RunInput) error

type RunInput ¶

type RunInput struct {
	RuleKey     string       // RuleKey is like the "max" in rule "max: 6"
	RulePattern string       // RulePattern is like "6" in rule:"max:6"
	Field       string       // The field name of Value.
	ValueType   reflect.Type // ValueType specifies the type of the value, which might be nil.
	Value       *gvar.Var    // Value specifies the value for this rule to validate.
	Data        *gvar.Var    // Data specifies the `data` which is passed to the Validator.
	Message     string       // Message specifies the custom error message or configured i18n message for this rule.
	Option      RunOption    // Option provides extra configuration for validation rule.
}

type RunOption ¶

type RunOption struct {
	CaseInsensitive bool // CaseInsensitive indicates that it does Case-Insensitive comparison in string.
}