Rust 编程——prost-build 使用

ByteX2024-06-09 15:56

Prost是一个用于生成Rust语言中的Protocol Buffers定义的库。而prost-build是Prost库的一个工具，用于生成Rust代码。Protocol Buffers是由Google开发的一种轻量级、高效的数据交换格式，可以用于结构化数据的序列化，特别适用于通信协议和数据存储等领域。

prost-build工具通过读取Protobuf文件（.proto文件）并根据文件中定义的消息类型、服务等生成相应的Rust代码。这些生成的Rust代码可用于在Rust项目中使用Protocol Buffers定义的数据结构和服务。

要使用prost-build，首先需要在Rust项目的Cargo.toml文件中添加相应的依赖：

toml 复制代码

[dependencies]
bytes = "0.4"
prost = "0.5"

[build-dependencies]
prost-build = "0.5"

然后，创建一个build.rs文件，用于配置和运行prost-build工具：
build.rs文件与Cargo.toml同级

rust 复制代码

extern crate prost_build;

fn main() {
    // prost_build::compile_protos(&["src/items.proto"], &["src/"]).unwrap();
    prost_build::Config::new()
        .out_dir("src/pb")
        .compile_protos(&["src/abi.proto"], &["src/"])
        .unwrap();
}

在src下创建pb文件夹，用于输出结果。

创建abi.proto文件：

rust 复制代码

syntax = "proto3";

package snazzy.items;

// A snazzy new shirt!
message Shirt {
    enum Size {
        SMALL = 0;
        MEDIUM = 1;
        LARGE = 2;
    }

    string color = 1;
    Size size = 2;
}

其中，src/abi.proto是你的Protobuf文件的路径，src/pb是生成的Rust代码的输出目录。

运行cargo build时，prost-build工具会自动读取Protobuf文件并生成相应的Rust代码，并将生成的代码放置在指定的输出目录中。

注意坑点

1.build.rs文件是否与Cargo.toml同级

2.是否在项目跟目录下运行cargo build

3.是否安装protoc并配置环境变量。