# RussellLuo-validating

**Repository Path**: github-image/russell-luo-validating

## Basic Information

- **Project Name**: RussellLuo-validating
- **Description**: Go 库，用于验证结构，map 和切片。带有各种各样的验证器工厂（它们生成实际的验证），包括相等性，范围，包含在一组值中，长度等。
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://github.com/RussellLuo/validating
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-10-26
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# validating

A Go library for validating structs, maps and slices.


## Features

1. Simple

    Simple and stupid, no magic involved.

2. Type-safe

    Schema is defined in Go, which is type-safer (and more powerful) than traditional struct tags.

3. Flexible

    - Validators are composite.
    - Nested struct validation is well supported.
    - Schema can be defined inside or outside struct.
    - Validator customizations are made easy.

4. No reflection


## Installation


```bash
$ go get -u github.com/RussellLuo/validating/v2
```


## Validator factories and validators

To be strict, this library has a conceptual distinction between `validator factory` and `validator`.

A validator factory is a function used to create a validator, which will do the actual validation.

### Built-in validator factories

- [Func](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Func)
- [Schema](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Schema)
- [Value](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Value)
- [Map](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Map)
- [Slice/Array](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Slice)
- [All/And](https://pkg.go.dev/github.com/RussellLuo/validating/v2#All)
- [Any/Or](https://pkg.go.dev/github.com/RussellLuo/validating/v2#All)
- [Not](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Not)
- [Lazy](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Lazy)
- [Assert](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Assert)
- [Nonzero](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Nonzero)
- [Len](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Len)
- [RuneCount](https://pkg.go.dev/github.com/RussellLuo/validating/v2#RuneCount)
- [Eq](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Eq)
- [Ne](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Ne)
- [Gt](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Gt)
- [Gte](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Gte)
- [Lt](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Lt)
- [Lte](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Lte)
- [Range](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Range)
- [In](https://pkg.go.dev/github.com/RussellLuo/validating/v2#In)
- [Nin](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Nin)
- [Match](https://pkg.go.dev/github.com/RussellLuo/validating/v2#Match)

### Validator customizations

- [From a boolean expression](example_nested_struct_pointer_test.go#L24)
- [From a function](example_customizations_test.go#L32)
- [From a struct](example_customizations_test.go#L22-L26)


## Examples

- [Simple value](example_simple_value_test.go)
- [Simple struct](example_simple_struct_test.go)
- [Simple map](example_simple_map_test.go)
- [Simple slice](example_simple_slice_test.go)
- [Nested struct](example_nested_struct_test.go)
- [Nested struct (schema inside)](example_nested_struct_schema_inside_test.go)
- [Nested struct pointer](example_nested_struct_pointer_test.go)
- [Nested struct slice](example_nested_struct_slice_test.go)
- [Nested struct map](example_nested_struct_map_test.go)


## Documentation

Check out the [Godoc][1].


## Thanks

This library borrows some ideas from the following libraries:

- [mholt/binding][2]

    Prefer no reflection.

- [alecthomas/voluptuous][3]

    Support composite-style validator factories `All`/`And`, `Any`/`Or`.

- [go-validator/validator][4]

    Use the term `nonzero` instead of `required`/`optional`.


## License

[MIT][5]


[1]: https://pkg.go.dev/github.com/RussellLuo/validating/v2
[2]: https://github.com/mholt/binding
[3]: https://github.com/alecthomas/voluptuous
[4]: https://github.com/go-validator/validator
[5]: http://opensource.org/licenses/MIT