validator

Documentation

Index

• Constants
• Variables
• func FormatUser(user *models.User)
• func GetInstance() *validator.Validate
• func GetInvalidFieldsFromErr(err error) ([]string, error)
• func GetInvalidFieldsValues(err error) (map[string]interface{}, error)
• func HashPassword(password string) string
• func ValidateField(structure interface{}, field, value string) bool
• func ValidateFieldEmail(email string) bool
• func ValidateFieldPassword(password string) bool
• func ValidateFieldTag(tag string) bool
• func ValidateFieldUsername(username string) bool
• func ValidateStruct(data interface{}) ([]string, error)
• func ValidateStructFields(data interface{}) (map[string]interface{}, error)
• func ValidateVar(data interface{}, tag string) ([]string, error)
• type Validator
  • func New() *Validator
  • func (v *Validator) Struct(structure interface{}) (bool, error)
  • func (v *Validator) Var(value, tags string) (bool, error)

Constants

const (
	// TagRegexp is the tag used to validate a regexp.
	TagRegexp = "regexp"
	// TagUsername is the tag used to validate ShellHub's username.
	TagUsername = "username"
)

Variables

var ErrInvalidError = errors.New("this error is not from a field validation")

var ErrInvalidFields = errors.New("invalid fields")

Functions

func FormatUser

func FormatUser(user *models.User)

FormatUser apply some formation rules to a models.User and encrypt the password.

func GetInstance

func GetInstance() *validator.Validate

func GetInvalidFieldsFromErr

func GetInvalidFieldsFromErr(err error) ([]string, error)

GetInvalidFieldsFromErr gets the invalids frields from a error returned by Struct function.

func GetInvalidFieldsValues

func GetInvalidFieldsValues(err error) (map[string]interface{}, error)

GetInvalidFieldsValues receive a structure validation error and return a map with invalid fields and values.

func HashPassword

func HashPassword(password string) string

func ValidateField

func ValidateField(structure interface{}, field, value string) bool

ValidateField validates if a structure's field is valid.

func ValidateFieldEmail

func ValidateFieldEmail(email string) bool

ValidateFieldEmail validate the data for the field Email from structure models.UserData.

func ValidateFieldPassword

func ValidateFieldPassword(password string) bool

ValidateFieldPassword validate the data for the field Password from structure models.UserPassword.

func ValidateFieldTag

func ValidateFieldTag(tag string) bool

ValidateFieldTag validate the data for the field Tag from structure models.Device.

func ValidateFieldUsername

func ValidateFieldUsername(username string) bool

ValidateFieldUsername validate the data for the field Username from structure models.UserData.

func ValidateStruct

func ValidateStruct(data interface{}) ([]string, error)

func ValidateStructFields

func ValidateStructFields(data interface{}) (map[string]interface{}, error)

func ValidateVar

func ValidateVar(data interface{}, tag string) ([]string, error)

Types

type Validator

type Validator struct {
	Validate *validator.Validate
}

func New

func New() *Validator

New creates a new ShellHub validator.

The ShellHub validator contains validations rules to name, username, email, password, etc.

func (*Validator) Struct

func (v *Validator) Struct(structure interface{}) (bool, error)

Struct validates a structure using ShellHub validation's tags.

func (*Validator) Var

func (v *Validator) Var(value, tags string) (bool, error)

Var validates a variable using a ShellHub validation's tags.