https://github.com/cemoktra/gin-tonic
tonic with gin
https://github.com/cemoktra/gin-tonic
grpc protobuf tonic
Last synced: about 1 year ago
JSON representation
tonic with gin
- Host: GitHub
- URL: https://github.com/cemoktra/gin-tonic
- Owner: cemoktra
- License: mit
- Created: 2024-06-11T09:24:33.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-07T07:29:31.000Z (over 1 year ago)
- Last Synced: 2025-03-27T20:51:16.393Z (about 1 year ago)
- Topics: grpc, protobuf, tonic
- Language: Rust
- Homepage:
- Size: 1.37 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gin-tonic
`gin-tonic` offers:
- a protobuf de-/serialization (like [`prost`](http://docs.rs/prost))
- a replacement for [`prost-build`](http://docs.rs/prost-build))
- a [`tonic`](http://docs.rs/tonic) codec implementation
- a wrapper for [`tonic-build`](http://docs.rs/tonic-build) adding some extra extra features
While all this can be achieved using the mentioned crates; `gin-tonic` also offers traits for
converting any Rust type into a protobuf wire type. You are asking why?
If you want to pass a UUID via protobuf you likely end up doing:
```protobuf
message Foo {
string my_uuid = 1;
}
```
Using [`prost-build`](http://docs.rs/prost-build) and [`tonic-build`](http://docs.rs/tonic-build) this will
generate the following Rust struct:
```rust
struct Foo {
my_uuid: String,
}
```
As you notice the Rust type here is `String`, but in your actual code you want to use an actual
[`uuid::Uuid`](docs.rs/uuid). Now you have to do a fallible conversion into your code.
`gin-tonic` solves this by adding options to the protobuf file:
```protobuf
import "gin/proto/gin.proto";
message Foo {
string my_uuid = 1 [(gin_tonic.v1.rust_type) = "uuid::Uuid"];
}
```
Using the `gin-tonic` code generator this generates the following Rust code:
```rust
struct Foo {
my_uuid: uuid::Uuid,
}
```
For the UUID case `gin-tonic` offers two features:
- `uuid_string` => proto transport is `string`, parsing error is handled within wire type conversion
- `uuid_bytes` => proto transport is `bytes`, this does not require additional error handling
You can add you own types by implementing the `PbType` trait for your type.
## Benchmarks
gin tonic:
```
decode time: [699.72 ns 700.71 ns 701.81 ns]
encode time: [451.35 ns 453.22 ns 455.56 ns]
```
prost:
```
decode time: [778.30 ns 782.24 ns 788.19 ns]
encode time: [622.77 ns 623.87 ns 625.02 ns]
```