Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / protobuf-codegen / 779961d05980fc965aa30168d1f4ba0abcc064f4
commit779961d05980fc965aa30168d1f4ba0abcc064f4[log] [tgz]
authorXin Li <delphij@google.com>Tue Nov 24 00:56:40 2020 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Tue Nov 24 00:56:40 2020 +0000
tree22450d346014c54c391910744bc39e20cbc42889
parent7d054f7c3978da2726ac79bc5cfbfa8b1b516137 [diff]
parent5f36290b111053cca151d5726c75545d4fd9a05f [diff]
Mark ab/6881855 as merged am: 2e060e3448 am: 5f36290b11

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

Change-Id: I4befaedd5a0a23d43676e437a26189d23621e720
tree: 22450d346014c54c391910744bc39e20cbc42889
  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
  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.