Google Git
Sign in
android / platform / external / rust / crates / protobuf-codegen / refs/heads/android12-tests-release
commit353b0cbedacb38af5bfa937f14e42d1ff2a0f917[log] [tgz]
authorandroid-build-team Robot <[email protected]>Sat Apr 10 03:05:41 2021 +0000
committerandroid-build-team Robot <[email protected]>Sat Apr 10 03:05:41 2021 +0000
tree9eeac22d97fb868a2a9113a2bc173486ded1c70d
parent058e7d87b808a199fe69ac55e7ddfb66f6adfa0c [diff]
parente49a6766b24f7742d40687e500754b6ed4e69c39 [diff]
Snap for 7272808 from e49a6766b24f7742d40687e500754b6ed4e69c39 to sc-release

Change-Id: Iadab5f3ed2b9ff0511eee811dffb87910fb9f4b6
tree: 9eeac22d97fb868a2a9113a2bc173486ded1c70d
  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. LICENSE.txt
  10. METADATA
  11. MODULE_LICENSE_MIT
  12. OWNERS
  13. README.android
  14. README.md
README.md

protobuf-codegen

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

protoc-gen-rust

protoc-gen-rust implements standard protobuf protoc plugin conventions.

Probably you do not want to use it directly in Rust environment, there are easier to use alternatives:

  • protoc-rust crate which can be invoked programmatically from build.rs of your project which requires only protoc in $PATH but not protoc-gen-rust.
  • protobuf-codegen-pure crate which behaves like protoc-rust, but does not depend on protoc binary

But if you really want to use that plugin, here's the instruction

(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.