#protobuf #prost #serde #derive

build prost-build-config

A prost toolkit to build protobuf with extra derive/attrs support

6 releases

0.6.3 Dec 21, 2023
0.6.1 Dec 20, 2023
0.5.0 Oct 7, 2022
0.4.1 Jan 22, 2022

#84 in Build Utils

Download history 368/week @ 2023-10-27 360/week @ 2023-11-03 519/week @ 2023-11-10 288/week @ 2023-11-17 228/week @ 2023-11-24 539/week @ 2023-12-01 267/week @ 2023-12-08 447/week @ 2023-12-15 186/week @ 2023-12-22 276/week @ 2023-12-29 322/week @ 2024-01-05 719/week @ 2024-01-12 533/week @ 2024-01-19 560/week @ 2024-01-26 359/week @ 2024-02-02 322/week @ 2024-02-09

1,934 downloads per month
Used in 2 crates (via rings-rpc)

MIT license

11KB
112 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

~8–20MB
~268K SLoC