Documentation
¶
Overview ¶
Package gvalid implements powerful and useful data/form validation functionality.
Index ¶
- func RegisterRule(rule string, f RuleFunc) error
- type CustomMsg
- type Error
- func (e *Error) Error() string
- func (e *Error) FirstItem() (key string, messages map[string]string)
- func (e *Error) FirstRule() (rule string, err string)
- func (e *Error) FirstString() (err string)
- func (e *Error) Map() map[string]string
- func (e *Error) Maps() ErrorMap
- func (e *Error) String() string
- func (e *Error) Strings() (errs []string)
- type ErrorMap
- type RuleFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterRule ¶
RegisterRule registers custom validation rule and function for package. It returns error if there's already the same rule registered previously.
Types ¶
type CustomMsg ¶
type CustomMsg = map[string]interface{}
CustomMsg is the custom error message type, like: map[field] => string|map[rule]string
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
Error is the validation error for validation result.
func Check ¶
Check checks single value with specified rules. It returns nil if successful validation.
The parameter <value> can be any type of variable, which will be converted to string for validation. The parameter <rules> can be one or more rules, multiple rules joined using char '|'. The parameter <messages> specifies the custom error messages, which can be type of: string/map/struct/*struct. The optional parameter <params> specifies the extra validation parameters for some rules like: required-*、same、different, etc.
func CheckMap ¶
CheckMap validates map and returns the error result. It returns nil if with successful validation.
The parameter <rules> can be type of []string/map[string]string. It supports sequence in error result if <rules> is type of []string. The optional parameter <messages> specifies the custom error messages for specified keys and rules.
func CheckStruct ¶
CheckStruct validates strcut and returns the error result.
The parameter <object> should be type of struct/*struct. The parameter <rules> can be type of []string/map[string]string. It supports sequence in error result if <rules> is type of []string. The optional parameter <messages> specifies the custom error messages for specified keys and rules.
func (*Error) FirstItem ¶
FirstItem returns the field name and error messages for the first validation rule error.
func (*Error) FirstString ¶
FirstString returns the first error message as string. Note that the returned message might be different if it has no sequence.
type RuleFunc ¶
RuleFunc is the custom function for data validation. The parameter <value> specifies the value for this rule to validate. The parameter <message> specifies the custom error message or configured i18n message for this rule. The parameter <params> specifies all the parameters that needs .
Source Files