20 releases (7 breaking)

0.8.0 Jan 20, 2025
0.7.0 Dec 16, 2024
0.6.0 Nov 14, 2024
0.1.0-rc.4 Jul 24, 2024

#18 in #cargo-manifest

Download history 8916/week @ 2024-10-28 6151/week @ 2024-11-04 6600/week @ 2024-11-11 4580/week @ 2024-11-18 4166/week @ 2024-11-25 4021/week @ 2024-12-02 4040/week @ 2024-12-09 5250/week @ 2024-12-16 463/week @ 2024-12-23 1938/week @ 2024-12-30 5133/week @ 2025-01-06 5914/week @ 2025-01-13 4596/week @ 2025-01-20 3644/week @ 2025-01-27 3434/week @ 2025-02-03 5595/week @ 2025-02-10

17,471 downloads per month
Used in 63 crates (9 directly)

MIT/Apache

40KB
717 lines

Generates rust code from the proto files.

Protobuf files are collected recursively from $CARGO_MANIFEST_DIR/<input_root>/ directory. Corresponding "cargo:rerun-if-changed=..." line is printed to stdout, so that the build script running this function is rerun whenever proto files change. A single rust file is generated and stored at $OUT_DIR/<input_root>/gen.rs file.

Protobuf files are compiled to a protobuf descriptor stored at $OUT_DIR/<input_root>/gen.binpb. Additionally a "PROTOBUF_DESCRIPTOR=" line is printed to stdout. This can be used to collect all the descriptors across the build as follows:

  1. Checkout the repo to a fresh directory and then run "cargo build --all-targets" We need it fresh so that every crate containing protobufs has only one build in the cargo cache.
  2. grep through all target/debug/build/*/output files to find all "PROTOBUF_DESCRIPTOR=..." lines and merge the descriptor files by simply concatenating them.

Note that you can run this procedure for 2 revisions of the repo and look for breaking changes by running "buf breaking <after.binpb> --against <before.binpb>" where before.binpb and after.binpb are the concatenated descriptors from those 2 revisions.

The proto files are not expected to be self-contained - to import proto files from different crates you need to specify them as dependencies in the Config.dependencies. It is not possible to depend on a different proto bundle within the same crate (because these are being built simultaneously from the same build script).

Dependencies

~13–24MB
~331K SLoC