Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / protobuf-codegen / 3e2cbebe5ded5679b295f1da8d441a74020dedd5
commit3e2cbebe5ded5679b295f1da8d441a74020dedd5[log] [tgz]
authorChih-hung Hsieh <chh@google.com>Wed Oct 21 06:01:10 2020 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Wed Oct 21 06:01:10 2020 +0000
tree0cb8ac5cbf23fdb23352659f614de903efd58b49
parent4bdbf204335cdc15cedbb9ba6115c18a0bf41844 [diff]
parent0dad75e4d837abc45aaee511dc19139338696ae2 [diff]
Merge "Use MIT license type, specified in Cargo.toml" am: 54ea0582f3 am: a75e2dec5a am: 0dad75e4d8

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

Change-Id: Id8ea2efea8839168a926f137e05d5c2cef800f4d
tree: 0cb8ac5cbf23fdb23352659f614de903efd58b49
  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. post_update.sh
  14. README.android
  15. README.md
  16. 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.