Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / protobuf-codegen / 07aa2185c6852bc7a1afe0491540363e2aa63306
commit07aa2185c6852bc7a1afe0491540363e2aa63306[log] [tgz]
authorandroid-build-team Robot <android-build-team-robot@google.com>Wed Jan 27 02:15:22 2021 +0000
committerandroid-build-team Robot <android-build-team-robot@google.com>Wed Jan 27 02:15:22 2021 +0000
tree5ea79b828479a200518a147fd67c1ada30f75452
parent4a23fe13713b0726a4f7079ecc0230acb3c734b8 [diff]
parent948dd37e6259c24bd78126b88f85eb31dae8976c [diff]
Snap for 7105071 from 948dd37e6259c24bd78126b88f85eb31dae8976c to sc-d1-release

Change-Id: I682b13f5f7ed9ca7bcb0f45c899f2e52b7d24917
tree: 5ea79b828479a200518a147fd67c1ada30f75452
  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.