govalidator

README

govalidator

Go Validator

document

Access api and example document

Documentation

Overview

Example

package main

import (
	"errors"
	"fmt"

	"github.com/swordlib/govalidator"
)

type person struct {
	FirstName string
}

func main() {
	gv := govalidator.New(govalidator.RulesMap{
		"FirstName": {
			{
				Required: true,
			},
			{
				Validator: func(rule *govalidator.Rule, value interface{}, target interface{}) error {

					if v := value.(string); v != "Alice" {
						return errors.New("FirstName must be Alice")
					}
					return nil
				},
			},
		},
	})
	fmt.Println(gv.StructFirst(&person{
		FirstName: "",
	}))
	fmt.Println(gv.StructFirst(&person{
		FirstName: "Bob",
	}))
	fmt.Println(gv.StructFirst(&person{
		FirstName: "Alice",
	}))

	custom := govalidator.New(govalidator.RulesMap{
		"FirstName": {
			{
				Required: true,
				Message:  "Please input your firstName",
			},
		},
	})
	fmt.Println(custom.StructFirst(&person{}))
}

Output:

FirstName is required
FirstName must be Alice
<nil>
Please input your firstName

Index

• type Rule
• type Rules
• type RulesMap
• type Validator
  • func New(rules RulesMap, varoptions ...*ValidatorOptions) *Validator
  • func (v *Validator) StructFirst(target interface{}) error
• type ValidatorFunc
• type ValidatorOptions

Examples

• Package

Types

type Rule

type Rule struct {
	Required  bool
	Validator ValidatorFunc
	Message   string
}

type Rules

type Rules []*Rule

type RulesMap

type RulesMap map[string]Rules

type Validator

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

Validator is a validation program for go

func New

func New(rules RulesMap, varoptions ...*ValidatorOptions) *Validator

New create a new validator

func (*Validator) StructFirst

func (v *Validator) StructFirst(target interface{}) error

StructFirst Validate a struct and stop when it encounter the first error. It will panic when call with other than struct or validate a not present struct field

type ValidatorFunc

type ValidatorFunc func(rule *Rule, value interface{}, target interface{}) error

ValidatorFunc is a custom validator type, alias of func(rule *Rule, value interface{}, target interface{}) error

type ValidatorOptions

type ValidatorOptions struct {
}

ValidatorOptions It's not used until now, just reserves for future