Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / protobuf-codegen / dc88dce33a19aa700ee2e2ec6c68eb5f6108030e
commitdc88dce33a19aa700ee2e2ec6c68eb5f6108030e[log] [tgz]
authorJoel Galenson <jgalenson@google.com>Wed Dec 15 16:43:27 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Wed Dec 15 16:43:27 2021 +0000
tree5e1187bc694e0f6bc7399aabab8abc8f56b88454
parent353baf7697c18cabd777523fec3fd8f9390cb7ef [diff]
parent6e0ac32e8618d45b40a67e29d14fd7ebaeec2b0d [diff]
Merge "Refresh Android.bp, cargo2android.json, TEST_MAPPING." am: f4fea204f3 am: 6e0ac32e86

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

Change-Id: I83ed2cc5ef8522d98ce30e65cca756b186543506
tree: 5e1187bc694e0f6bc7399aabab8abc8f56b88454
  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. cargo2android.json
  10. LICENSE.txt
  11. METADATA
  12. MODULE_LICENSE_MIT
  13. OWNERS
  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.