prost-helper

提供两个 crate 以帮助 prost 更好地与 protobuf 合作

• prost-build-config：使用 prost 和 protobuf 文件生成与 serde 兼容的代码。更多信息请参见 文档。
• prost-helper：用于 prost 的宏和函数。更多信息请参见 文档。

在 Cargo 项目中使用 prost-helper

首先，将 prost-build-config 和 prost-helper 添加到您的 Cargo.toml 文件中

[dependencies]
prost-helper = "0.6"

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

然后，将 prost-build-config/default_build_config.yml 复制到您的项目中并自定义它。更多信息请参见 prost-build-config/examples/build_config.yml。然后，您可以在 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();
}

就是这样！

如果您想为 From 特性生成到 Vec<u8> 或从 Vec<u8> 到 protobuf 数据结构生成 TryFrom 特性，可以使用 prost_into_vec! 和 vec_try_into_prost! 宏。以下是一个示例

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();

享受使用 prost 的乐趣！

许可证

prost-helper 在 MIT 许可下分发。

有关详细信息，请参阅 LICENSE。

版权所有 2021 Tyr Chen