blob: b4442809384e684d026f78f20fa804b1b6c94370 [file] [log] [blame] [view]
The build time dependency crate for generating code for the official Google Rust
Protobuf implementation.
The code generated by this is expected to be used in conjunction with the
official [Protobuf crate](http://crates.io/crates/protobuf).
This is currently a beta release: the API is subject to change,
and there may be some rough edges, including missing documentation and features.
# How to get a compatible version of protoc
The protoc binary that you use to generate code needs to have a version that
exactly matches the version of the protobuf crate you are using. More
specifically, if you are using Rust protobuf `x.y.z` then you need to use protoc
`y.z`. See [here](https://protobuf.dev/support/version-support/) for more
details on our versioning scheme.
The easiest way to get ahold of protoc is to download a prebuilt binary from the
matching release [here](https://github.com/protocolbuffers/protobuf/releases).
Just make sure protoc is on your `$PATH` when you run `cargo`.