#protobuf #serialization

build protox

A rust implementation of the protobuf compiler

14 unstable releases (5 breaking)

0.6.0 Feb 7, 2024
0.5.1 Nov 2, 2023
0.5.0 Sep 1, 2023
0.4.1 Jun 25, 2023
0.1.0 Jul 25, 2022

#623 in Build Utils

Download history 17075/week @ 2023-11-02 11642/week @ 2023-11-09 14362/week @ 2023-11-16 11614/week @ 2023-11-23 18680/week @ 2023-11-30 20194/week @ 2023-12-07 15191/week @ 2023-12-14 10639/week @ 2023-12-21 11804/week @ 2023-12-28 26826/week @ 2024-01-04 25421/week @ 2024-01-11 28990/week @ 2024-01-18 23448/week @ 2024-01-25 24370/week @ 2024-02-01 21071/week @ 2024-02-08 15514/week @ 2024-02-15

90,383 downloads per month
Used in 15 crates (4 directly)

MIT/Apache

220KB
5K SLoC

crates.io docs.rs deps.rs MSRV Continuous integration codecov Apache 2.0 OR MIT licensed

protox

An implementation of the protobuf compiler in rust, intended for use as a library with crates such as prost-build to avoid needing to build protoc.

Examples

Compiling a single source file:

assert_eq!(protox::compile(["root.proto"], ["."]).unwrap(), FileDescriptorSet {
    file: vec![
        FileDescriptorProto {
            name: Some("root.proto".to_owned()),
            /* ... */
        }
    ],
});

Usage with prost-build:

let file_descriptors = protox::compile(["root.proto"], ["."]).unwrap();
prost_build::compile_fds(file_descriptors).unwrap();

Usage with tonic-build:

let file_descriptors = protox::compile(["root.proto"], ["."]).unwrap();

let file_descriptor_path = PathBuf::from(env::var_os("OUT_DIR").expect("OUT_DIR not set"))
    .join("file_descriptor_set.bin");
fs::write(&file_descriptor_path, file_descriptors.encode_to_vec()).unwrap();

tonic_build::configure()
    .build_server(true)
    .file_descriptor_set_path(&file_descriptor_path)
    .skip_protoc_run()
    .compile(&["root.proto"], &["."])
    .unwrap();

Error messages

This crate uses miette to add additional details to errors. For nice error messages, add miette as a dependency with the fancy feature enabled and return a miette::Result from your build script.

fn main() -> miette::Result<()> {
  let _ = protox::compile(["root.proto"], ["."])?;

  Ok(())
}

Example error message:

Error:
  × name 'Bar' is not defined
   ╭─[root.proto:3:1]
 3 │ message Foo {
 4 │     Bar bar = 1;
   ·     ─┬─
   ·      ╰── found here
 5}
   ╰────

Minimum Supported Rust Version

Rust 1.70 or higher.

The minimum supported Rust version may be changed in the future, but it will be done with a minor version bump.

License

Licensed under either of

at your option.

This project includes code imported from the Protocol Buffers project, which is included under its original (BSD) license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~3.5–5MB
~68K SLoC