21 releases (8 breaking)

new 0.9.0 Mar 5, 2025
0.7.0 Dec 16, 2024
0.6.0 Nov 14, 2024
0.1.0-rc.4 Jul 24, 2024

#256 in Magic Beans

Download history 4824/week @ 2024-11-16 4268/week @ 2024-11-23 4066/week @ 2024-11-30 4018/week @ 2024-12-07 5181/week @ 2024-12-14 520/week @ 2024-12-21 1888/week @ 2024-12-28 4668/week @ 2025-01-04 6022/week @ 2025-01-11 5031/week @ 2025-01-18 3649/week @ 2025-01-25 3427/week @ 2025-02-01 5554/week @ 2025-02-08 4686/week @ 2025-02-15 3243/week @ 2025-02-22 6330/week @ 2025-03-01

20,678 downloads per month
Used in 62 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
~336K SLoC