Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / protobuf-codegen / e6fcd6b3bb348d30f39f5c686f8de0b936d6e265
commite6fcd6b3bb348d30f39f5c686f8de0b936d6e265[log] [tgz]
authorChih-Hung Hsieh <chh@google.com>Tue Jul 21 21:14:39 2020 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Tue Jul 21 21:14:39 2020 +0000
tree395afd075aa22cb4bd3f26d379a9fa1f55cce1a0
parentf5740ecf23981205f7bfb507915977a254f7b44b [diff]
parentff20eba123b6e0406a4ca6dabaab47e03f1f7731 [diff]
Add rust_test and update TEST_MAPPING am: 35dedf6a77 am: ff20eba123

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

Change-Id: I159d7501f30f6f0601a258ee89914cf408bd8579
tree: 395afd075aa22cb4bd3f26d379a9fa1f55cce1a0
  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
  15. TEST_MAPPING
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.