Google Git
Sign in
android / platform / external / rust / crates / protobuf-codegen / refs/heads/android13-platform-release
commit3cf0d92f5b2e1b6113aad338f46f4fb345a37a73[log] [tgz]
authorAndroid Build Coastguard Worker <[email protected]>Tue Nov 01 21:33:06 2022 +0000
committerAndroid Build Coastguard Worker <[email protected]>Tue Nov 01 21:33:06 2022 +0000
treeeda2c3bcc49d645d0edc2b67d1b0dd8ce05e8ec4
parent12e6f11d6a8c8faaa0d8ba9928d0213240d0f205 [diff]
parente5d6971662c112d4a683f1b9a52c4bf7aa4977e2 [diff]
Snap for 9239618 from e5d6971662c112d4a683f1b9a52c4bf7aa4977e2 to tm-platform-release

Change-Id: I2463b93914cd8d4cb3bc0ec6ed3153bb24aa52f6
tree: eda2c3bcc49d645d0edc2b67d1b0dd8ce05e8ec4
  1. src/
  2. LICENSE ⇨ LICENSE.txt
  3. NOTICE ⇨ LICENSE
  4. .cargo_vcs_info.json
  5. Android.bp
  6. Cargo.lock
  7. Cargo.toml
  8. Cargo.toml.orig
  9. cargo2android.json
  10. LICENSE.txt
  11. METADATA
  12. MODULE_LICENSE_MIT
  13. OWNERS
  14. README.md
README.md

Protobuf code generator

This crate contains protobuf code generator implementation and a protoc-gen-rust protoc plugin.

This crate:

  • provides protoc-gen-rust plugin for protoc command
  • implement protobuf codegen

This crate is not meant to be used directly, in fact, it does not provide any public API (except for protoc-gen-rust binary).

Code can be generated with either:

  • protoc-gen-rust plugin for protoc or
  • protoc-rust crate (code generator which depends on protoc binary for parsing of .proto files)
  • protobuf-codegen-pure crate, similar API to protoc-rust, but uses pure rust parser of .proto files.

protoc-gen-rust plugin for protoc

When non-cargo build system is used, consider using standard protobuf code generation pattern: protoc command does all the work of handling paths and parsing .proto files. When protoc is invoked with --rust_out= option, it invokes protoc-gen-rust plugin. provided by this crate.

When building with cargo, consider using protoc-rust or protobuf-codegen-pure crates.

How to use protoc-gen-rust if you have to

(Note protoc can be invoked programmatically with protoc crate)

  1. Install protobuf for protoc binary.

On OS X Homebrew can be used:

brew install protobuf

On Ubuntu, protobuf-compiler package can be installed:

apt-get install protobuf-compiler

Protobuf is needed only for code generation, rust-protobuf runtime does not use protobuf library.

  1. Install protoc-gen-rust program (which is protoc plugin)

It can be installed either from source or with cargo install protobuf command.

  1. Add protoc-gen-rust to $PATH

If you installed it with cargo, it should be

PATH="$HOME/.cargo/bin:$PATH"
  1. Generate .rs files:
protoc --rust_out . foo.proto

This will generate .rs files in current directory.

Version 2

This is documentation for version 2 of the crate.

Version 3 of the crate (currently in development) encapsulates both protoc and pure codegens in this crate.