Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / protobuf-codegen / c4669a5cbe1f23a2515826463badde6abcd4923d
commitc4669a5cbe1f23a2515826463badde6abcd4923d[log] [tgz]
authorJoel Galenson <jgalenson@google.com>Thu Oct 14 18:23:31 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Thu Oct 14 18:23:31 2021 +0000
tree1689e4f298d0053c296f1033eaf5a13204ba6a92
parent9d6abb182c7926a6f32a3101d29e9bba8df631fe [diff]
parentdafb9684c423543957a43185916251d0a88a5376 [diff]
Merge "Upgrade rust/crates/protobuf-codegen to 2.25.1" am: dafb9684c4

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

Change-Id: I9a6dac30c06f6ac9ff55ddad4e7bcab70c298cb9
tree: 1689e4f298d0053c296f1033eaf5a13204ba6a92
  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
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.