Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / protobuf-codegen / df0a06f3eccc64341a1c96f37fbb8e7780eb59b7
commitdf0a06f3eccc64341a1c96f37fbb8e7780eb59b7[log] [tgz]
authorXin Li <delphij@google.com>Sat Aug 14 06:42:19 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Sat Aug 14 06:42:19 2021 +0000
treefafdecfbe1360449dedb04dc6cd3b4a6c1c1083f
parentd3a783d6098fc0dc6a33b69f6f6ae5b893a4ff90 [diff]
parentac0109fc6a3f23b9cc40a11da1faed5b1dce86fb [diff]
[automerger skipped] Mark sc-dev-plus-aosp-without-vendor@7634622 as merged am: 9d6abb182c -s ours am: ac0109fc6a -s ours

am skip reason: Merged-In I5de8dc7d0ee573c02ac3ed90bac485df5f8dcdd8 with SHA-1 48aae05446 is already in history

Original change: https://googleplex-android-review.googlesource.com/c/platform/external/rust/crates/protobuf-codegen/+/15571561

Change-Id: Id32f8aaeafb27c13da66f7da280d4940c1266e39
tree: fafdecfbe1360449dedb04dc6cd3b4a6c1c1083f
  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.