Google Git
Sign in
android / platform / external / rust / crates / protobuf-codegen / 2bb3181dc86a227fc1930d9247a3e668d17cc2d1
commit2bb3181dc86a227fc1930d9247a3e668d17cc2d1[log] [tgz]
authorXin Li <delphij@google.com>Sat Feb 20 15:52:29 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Sat Feb 20 15:52:29 2021 +0000
treeb8437a90846688be84adcc10dbe9584d9689e006
parente2356aff2bd01d2bceda85c4f85e438a15811886 [diff]
parentb9a1946bf2765f49995071d206bacf338ea6558d [diff]
[automerger skipped] Mark ab/7061308 as merged in stage. am: e3574261dc -s ours am: 7d83a0ce10 -s ours am: b9a1946bf2 -s ours

am skip reason: Change-Id I2abeb0fc28b199f2ca8d678cd5641918567926fe with SHA-1 21479602c3 is in history

Original change: undetermined

MUST ONLY BE SUBMITTED BY AUTOMERGER

Change-Id: I724175c4ce04541a3f4b56ef329cc0397b4e7d0a
tree: b8437a90846688be84adcc10dbe9584d9689e006
  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.