25个版本 (13个破坏性更新)

0.14.0 2023年3月19日
0.12.0 2023年2月19日
0.7.0 2022年12月5日
0.6.0 2022年10月17日
0.3.1 2021年11月9日

#658 in 网络编程


4个crate中使用了(3个直接使用)

Apache-2.0

1MB
19K SLoC

puroro,Rust的协议缓冲区实现

为Rust语言提供的另一个协议缓冲区编译器实现。该项目受Apache 2.0许可协议保护。

这不是一个官方支持的产品。

有关更多信息,请参阅puroro/src/lib.rs

重要提示

此库正在开发中,因此可能需要进行破坏性更改。

目前此库仅支持Rust夜间频道。

如何将.pb文件编译为.rs文件

首先,让我们为您的.pb文件(以及生成的.rs文件)创建一个crate。实际上,不需要为proto文件创建单独的crate,尽管我建议这样做以避免任何意外问题。

$ cargo new my-examples --lib
$ cd my-examples

# Create your .proto files under this directory
$ mkdir protos

# Edit your .proto files
$ emacs-vim-nano-or-whatever ./protos/yourproto.proto

以下是一个简单的proto文件示例:test1.proto

syntax = "proto3";
package library;
message Book {
    string title = 1;
    uint32 num_pages = 2;
}

请注意,文件名对生成的代码没有任何影响。只有包名(在这种情况下,package library;)会影响生成的代码的模块名(或文件名)。

然后编辑Cargo.toml以添加对puroro库crate的依赖项

[dependencies]
puroro = "*"

[build-dependencies]
puroro-codegen = "*"
protoc-bin-vendored = "3.0.0"

最后一步是在crate根目录下创建一个名为build.rs的文件。检查我们的示例build.rs,并将其复制粘贴。

完成这些步骤后,目录应如下所示

+ my-examples/
    ├ src/
    │   └ (empty)
    ├ protos/
    │   └ test1.proto
    ├ cargo.toml
    ├ build.rs
    ├ (some other generated files)

然后运行cargo build命令。如果成功运行,则生成的.rs文件将位于src/目录下,您可以从自己的crate中使用它。恭喜!

子crate

  • puroro -- 需要导入库的用户所用的crate
  • codegen -- 从给定的.proto文件信息生成Rust代码
  • inline -- 提供一个宏,可以直接在Rust代码中写入proto代码。目前仅用于测试目的,未发布。
  • tests -- 测试用例

待办事项

  • proto2
    • 组,至少正确忽略它
    • 枚举(在proto2中我们需要拒绝未知值)
    • 默认值(类似于optional int32 foo = 1; [default=10]
    • 扩展
  • proto2 & 3
    • 映射
    • OneOfs
      • 类型定义
      • 序列化 / 反序列化
    • Anys,以及其他已知类型
    • 枚举允许别名选项
    • 更多的单元测试
    • 更多的文档
    • 将原始.proto文件的注释打印到生成的文件中
    • 反射
      • 获取消息元数据(描述符)
    • 夜间/稳定功能
      • 支持稳定(不使用夜间功能)
    • 消息特性
    • 保留未知字段
    • 从切片中反序列化
    • 序列化性能改进
    • 自定义反序列化者(?)
    • 必需字段检查器
    • 支持allocator_api
    • RPCs / 服务
    • 一次性获取多个字段的可变引用
    • 为每个消息类型提供一个开放的struct,以便用户可以使用结构体初始化语法和..Default::default()语法轻松构建消息实例。
    • proc_macro生成内联消息。用于测试目的。

依赖项

~1.2–1.7MB
~41K SLoC