#protobuf #json #serde

pbjson-build

Generates Serialize and Deserialize implementations for prost message types

5 releases

Uses new Rust 2021

0.2.2 Jan 13, 2022
0.2.1 Nov 10, 2021
0.2.0 Oct 18, 2021
0.1.1 Dec 7, 2021
0.1.0 Sep 28, 2021

#230 in Encoding

Download history 688/week @ 2021-10-04 784/week @ 2021-10-11 838/week @ 2021-10-18 393/week @ 2021-10-25 449/week @ 2021-11-01 320/week @ 2021-11-08 402/week @ 2021-11-15 684/week @ 2021-11-22 637/week @ 2021-11-29 497/week @ 2021-12-06 360/week @ 2021-12-13 169/week @ 2021-12-20 22/week @ 2021-12-27 133/week @ 2022-01-03 338/week @ 2022-01-10 590/week @ 2022-01-17

1,084 downloads per month
Used in pbjson-types

MIT license

66KB
1.5K SLoC

Pbjson

Pbjson is a set of crates to automatically generate serde Serialize and Deserialize implementations for auto-generated prost types.

See pbjson-build for usage instructions


lib.rs:

pbjson-build consumes the descriptor output of prost-build and generates serde::Serialize and serde::Deserialize implementations that are compliant with the protobuf JSON mapping

Usage

It is recommended you first follow the example in prost-build to familiarise yourself with prost

Add prost-build, prost, pbjson, pbjson-build and pbjson-types to your Cargo.toml

[dependencies]
prost = <prost-version>
pbjson = <pbjson-version>
pbjson-types = <pbjson-version>

[build-dependencies]
prost-build = <prost-version>
pbjson-build = <pbjson-version>

Next create a build.rs containing the following

// This assumes protobuf files are under a directory called `protos`
// and in a protobuf package `mypackage`

let root = PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("protos");
let proto_files = vec![root.join("myproto.proto")];

// Tell cargo to recompile if any of these proto files are changed
for proto_file in &proto_files {
    println!("cargo:rerun-if-changed={}", proto_file.display());
}

let descriptor_path = PathBuf::from(env::var("OUT_DIR").unwrap())
    .join("proto_descriptor.bin");

prost_build::Config::new()
    // Save descriptors to file
    .file_descriptor_set_path(&descriptor_path)
    // Override prost-types with pbjson-types
    .compile_well_known_types()
    .extern_path(".google.protobuf", "::pbjson_types")
    // Generate prost structs
    .compile_protos(&proto_files, &[root])?;

let descriptor_set = std::fs::read(descriptor_path)?;
pbjson_build::Builder::new()
    .register_descriptors(&descriptor_set)?
    .build(&[".mypackage"])?;

Finally within lib.rs

/// Generated by [`prost-build`]
include!(concat!(env!("OUT_DIR"), "/mypackage.rs"));
/// Generated by [`pbjson-build`]
include!(concat!(env!("OUT_DIR"), "/mypackage.serde.rs"));

The module will now contain the generated prost structs for your protobuf definition along with compliant implementations of serde::Serialize and serde::Deserialize

Dependencies

~650KB
~13K SLoC