#prost #protobuf #serde #macro-helpers #prost-build

prost-helper

A set of prost helper functions to make prost generated code easy to work with

14 releases (7 breaking)

0.8.3 Dec 22, 2023
0.7.0 Oct 7, 2022
0.6.0 Nov 25, 2021
0.5.0 Feb 28, 2021

#219 in Development tools

Download history 25/week @ 2023-12-22 6/week @ 2023-12-29 39/week @ 2024-01-05 109/week @ 2024-01-12 67/week @ 2024-01-19 165/week @ 2024-01-26 319/week @ 2024-02-02 334/week @ 2024-02-09 168/week @ 2024-02-16 448/week @ 2024-02-23 303/week @ 2024-03-01 536/week @ 2024-03-08 463/week @ 2024-03-15 256/week @ 2024-03-22 398/week @ 2024-03-29 492/week @ 2024-04-05

1,773 downloads per month
Used in 10 crates (4 directly)

MIT license

27KB
620 lines

prost-helper

Two crates are provided to facilitate prost to better work with protobuf:

  • prost-build-config: help you to generate serde compatible code with prost and protobuf files. More in documentation.
  • prost-helper: macros and functions to facilitate prost. More in documentation.

Using prost-helper in a Cargo Project

First, add prost-build-config and prost-helper to your Cargo.toml:

[dependencies]
prost-helper = "0.6"

[build-dependencies]
prost-build-config = "0.4"

Then copy the prost-build-config/default_build_config.yml to your project and customize it. See more information in prost-build-config/examples/build_config.yml. Then you could add this in your build.rs:

use prost_build_config::{BuildConfig, Builder};

fn main() {
    let config: BuildConfig = serde_yaml::from_str(include_str!("path/to/your/build_config.yml")).unwrap();
    Builder::from(config).build_protos();
}

That's it!

If you'd like to generate the implementation for From trait to Vec<u8>, or TryFrom trait from Vec<u8> to protobuf data structure, you could use prost_into_vec! and vec_try_into_prost! macros. Here is an example:

use prost::Message;
use std::convert::TryInto;

#[derive(Clone, PartialEq, Eq, Message)]
pub struct Hello {
    #[prost(string, tag = "1")]
    pub msg: String,
}

// implement the traits
prost_into_vec!(Hello, 32);
vec_try_into_prost!(Hello);


let hello = Hello::default();

// use `Into` to convert message to `Vec<u8>`
let data: Vec<u8> = hello.into();

// use `TryInto` to convert `Vec<u8>` back to message
let hello_result: Result<Hello, prost::DecodeError> = data.try_into();

Have fun with prost!

License

prost-helper is distributed under the terms of MIT.

See LICENSE for details.

Copyright 2021 Tyr Chen

Dependencies

~0.7–1.7MB
~35K SLoC