Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / protobuf-codegen / 9668738aaec5fd7577fea2fbf48d57236c2107f3
commit9668738aaec5fd7577fea2fbf48d57236c2107f3[log] [tgz]
authorChih-Hung Hsieh <chh@google.com>Thu Jun 25 19:50:00 2020 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Thu Jun 25 19:50:00 2020 +0000
treeb6b600f5efa56977e52c9439d9efcca10395e2ea
parent576a7f7dce357413fefb159b8fcb1540c1462162 [diff]
parente6643d8d5edd832ed3c462a8dd0be301b0bc5abf [diff]
Import protobuf-codegen-2.14.0 am: 92ff605097 am: e6643d8d5e

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

Change-Id: If01f3ed409cfff05112f2aa34a8dc01a4445cfd4
tree: b6b600f5efa56977e52c9439d9efcca10395e2ea
  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_BSD_LIKE
  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.