2020-01-30 01:31:25 +01:00
# actix-protobuf
2021-06-27 08:28:26 +02:00
> Protobuf support for Actix Web.
[![crates.io ](https://img.shields.io/crates/v/actix-protobuf?label=latest )](https://crates.io/crates/actix-protobuf)
[![Documentation ](https://docs.rs/actix-protobuf/badge.svg?version=0.7.0-beta.1 )](https://docs.rs/actix-protobuf/0.7.0-beta.1)
2020-01-30 02:14:55 +01:00
![Apache 2.0 or MIT licensed ](https://img.shields.io/crates/l/actix-protobuf )
2021-06-27 08:28:26 +02:00
[![Dependency Status ](https://deps.rs/crate/actix-protobuf/0.7.0-beta.1/status.svg )](https://deps.rs/crate/actix-protobuf/0.7.0-beta.1)
2018-03-21 23:46:27 +01:00
2021-06-27 08:28:26 +02:00
## Documentation & Resources
2018-03-21 23:46:27 +01:00
2021-06-27 08:28:26 +02:00
- [API Documentation ](https://docs.rs/actix-protobuf )
- [Example Project ](https://github.com/actix/examples/tree/master/other/protobuf )
2021-10-19 02:48:41 +02:00
- Minimum Supported Rust Version (MSRV): 1.52
2020-01-30 08:09:05 +01:00
2018-03-21 23:46:27 +01:00
## Example
```rust,ignore
2020-01-24 18:39:32 +01:00
use actix_protobuf::*;
use actix_web::*;
2018-03-21 23:46:27 +01:00
2020-01-24 18:39:32 +01:00
#[derive(Clone, PartialEq, Message)]
2018-03-21 23:46:27 +01:00
pub struct MyObj {
2020-01-24 18:39:32 +01:00
#[prost(int32, tag = "1")]
2018-03-21 23:46:27 +01:00
pub number: i32,
2020-01-24 18:39:32 +01:00
#[prost(string, tag = "2")]
2018-03-21 23:46:27 +01:00
pub name: String,
}
2020-01-24 18:39:32 +01:00
async fn index(msg: ProtoBuf< MyObj > ) -> Result< HttpResponse > {
2018-04-10 21:42:41 +02:00
println!("model: {:?}", msg);
2020-01-24 18:39:32 +01:00
HttpResponse::Ok().protobuf(msg.0) // < - send response
2018-03-21 23:46:27 +01:00
}
```
2018-03-21 23:50:38 +01:00
2020-10-14 22:41:05 +02:00
See [here ](https://github.com/actix/actix-extras/tree/master/actix-protobuf/examples/prost-example ) for the complete example.
2020-01-24 18:39:32 +01:00
2018-03-21 23:50:38 +01:00
## License
This project is licensed under either of
2021-06-27 08:28:26 +02:00
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or [https://www.apache.org/licenses/LICENSE-2.0 ](https://www.apache.org/licenses/LICENSE-2.0 ))
- MIT license ([LICENSE-MIT](LICENSE-MIT) or [https://opensource.org/licenses/MIT ](https://opensource.org/licenses/MIT ))
2018-03-21 23:50:38 +01:00
at your option.