tree: ee0c8f7fc17e0ab32f3267b0d4eb42360e6e9077 [path history] [tgz]
  1. src/
  2. .cargo-checksum.json
  3. Cargo.toml
  4. LICENSE
  5. OWNERS
  6. README.md
third_party/rust_crates/vendor/prost-build-0.11.1/README.md

Documentation Crate

prost-build

prost-build makes it easy to generate Rust code from .proto files as part of a Cargo build. See the crate documentation for examples of how to integrate prost-build into a Cargo project.

protoc

prost-build uses protoc to parse the proto files. There are a few ways to make protoc available for prost-build.

The first option is to include protoc in your PATH this can be done by following the protoc install instructions. In addition, its possible to pass the PROTOC=<my/path/to/protoc> environment variable.

The second option is to provide the vendored feature flag to prost-build. This will force prost-build to compile protoc from the bundled source. This will require that you have the correct dependencies installed include a C++ toolchain, cmake, etc. For more info on what the required dependencies are check here.

If you would like to always ignore vendoring protoc you can additionally pass PROTOC_NO_VENDOR and this will always check the PATH/PROTOC environment variables and never compile protoc from source.

License

prost-build is distributed under the terms of the Apache License (Version 2.0).

See LICENSE for details.

Copyright 2017 Dan Burkert