Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linka-cloud/prost-validate
Prost support for protoc-gen-validate annotations
https://github.com/linka-cloud/prost-validate
grpc protobuf protocol-buffers rust rust-build rust-lang rust-library
Last synced: 3 months ago
JSON representation
Prost support for protoc-gen-validate annotations
- Host: GitHub
- URL: https://github.com/linka-cloud/prost-validate
- Owner: linka-cloud
- License: apache-2.0
- Created: 2024-09-17T09:55:44.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-16T08:41:13.000Z (3 months ago)
- Last Synced: 2024-10-18T01:43:56.547Z (3 months ago)
- Topics: grpc, protobuf, protocol-buffers, rust, rust-build, rust-lang, rust-library
- Language: Rust
- Homepage:
- Size: 307 KB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/linka-cloud/prost-validate/actions/workflows/ci_derive.yml)
# Prost Validate
This is a Rust implementation of [protoc-gen-validate](https://github.com/bufbuild/protoc-gen-validate).
It must be used with [prost](https://github.com/tokio-rs/prost) generated code.
All validation rules are documented in the [proto file](../prost-validate-types/proto/validate/validate.proto)
or in the [protoc-gen-validate](https://github.com/bufbuild/protoc-gen-validate/blob/v1.1.0/README.md#constraint-rules)
documentation.
It provides two implementations:
- A derive based implementation in the [prost-validate](prost-validate/README.md) crate.
- A reflection based implementation in the [prost-reflect-validate](prost-reflect-validate/README.md) crate.
The [test suite](prost-validate-tests) adapted from
the [protoc-gen-validate harness tests](https://github.com/bufbuild/protoc-gen-validate/blob/v1.1.0/tests/harness/executor/cases.go)
is shared between the two implementations.
Here are the benchmarks for the tests suite of the two implementations:
`prost-reflect-validate`:
```
harness reflect time: [14.849 ms 15.128 ms 15.459 ms]
```
`prost-validate`:
```
harness derive time: [2.5635 ms 2.5780 ms 2.5967 ms]
```
### Constraint Rule Comparison
#### Global
| Constraint Rule | Derive | Reflect |
|-----------------|:------:|:-------:|
| disabled | ✅ | ✅ |
#### Numerics
| Constraint Rule | Derive | Reflect |
|-----------------|:------:|:-------:|
| const | ✅ | ✅ |
| lt/lte/gt/gte | ✅ | ✅ |
| in/not_in | ✅ | ✅ |
#### Bools
| Constraint Rule | Derive | Reflect |
|-----------------|:------:|:-------:|
| const | ✅ | ✅ |
#### Strings
| Constraint Rule | Derive | Reflect |
|------------------------|:------:|:-------:|
| const | ✅ | ✅ |
| len/min\_len/max_len | ✅ | ✅ |
| min\_bytes/max\_bytes | ✅ | ✅ |
| pattern | ✅ | ✅ |
| prefix/suffix/contains | ✅ | ✅ |
| contains/not_contains | ✅ | ✅ |
| in/not_in | ✅ | ✅ |
| email | ✅ | ✅ |
| hostname | ✅ | ✅ |
| address | ✅ | ✅ |
| ip | ✅ | ✅ |
| ipv4 | ✅ | ✅ |
| ipv6 | ✅ | ✅ |
| uri | ✅ | ✅ |
| uri_ref | ✅ | ✅ |
| uuid | ✅ | ✅ |
| well_known_regex | ✅ | ✅ |
#### Bytes
| Constraint Rule | Derive | Reflect |
|------------------------|:------:|:-------:|
| const | ✅ | ✅ |
| len/min\_len/max_len | ✅ | ✅ |
| pattern | ✅ | ✅ |
| prefix/suffix/contains | ✅ | ✅ |
| in/not_in | ✅ | ✅ |
| ip | ✅ | ✅ |
| ipv4 | ✅ | ✅ |
| ipv6 | ✅ | ✅ |
#### Enums
| Constraint Rule | Derive | Reflect |
|-----------------|:------:|:-------:|
| const | ✅ | ✅ |
| defined_only | ✅ | ✅ |
| in/not_in | ✅ | ✅ |
#### Messages
| Constraint Rule | Derive | Reflect |
|-----------------|:------:|:-------:|
| skip | ✅ | ✅ |
| required | ✅ | ✅ |
#### Repeated
| Constraint Rule | Derive | Reflect |
|----------------------|:------:|:-------:|
| min\_items/max_items | ✅ | ✅ |
| unique | ✅ | ✅ |
| items | ✅ | ✅ |
#### Maps
| Constraint Rule | Derive | Reflect |
|----------------------|:------:|:-------:|
| min\_pairs/max_pairs | ✅ | ✅ |
| no_sparse | ❓ | ❓ |
| keys | ✅ | ✅ |
| values | ✅ | ✅ |
#### OneOf
| Constraint Rule | Derive | Reflect |
|-----------------|:------:|:-------:|
| required | ✅ | ✅ |
#### WKT Scalar Value Wrappers
| Constraint Rule | Derive | Reflect |
|--------------------|:------:|:-------:|
| wrapper validation | ✅ | ✅ |
#### WKT Any
| Constraint Rule | Derive | Reflect |
|-----------------|:------:|:-------:|
| required | ✅ | ✅ |
| in/not_in | ✅ | ✅ |
#### WKT Duration
| Constraint Rule | Derive | Reflect |
|-----------------|:------:|:-------:|
| required | ✅ | ✅ |
| const | ✅ | ✅ |
| lt/lte/gt/gte | ✅ | ✅ |
| in/not_in | ✅ | ✅ |
#### WKT Timestamp
| Constraint Rule | Derive | Reflect |
|-----------------|:------:|:-------:|
| required | ✅ | ✅ |
| const | ✅ | ✅ |
| lt/lte/gt/gte | ✅ | ✅ |
| lt_now/gt_now | ✅ | ✅ |
| within | ✅ | ✅ |