Google Git
Sign in
android / platform / external / rust / crates / protobuf-codegen / e3574261dcbbc73abdde6af7e8197c7b711573eb
commite3574261dcbbc73abdde6af7e8197c7b711573eb[log] [tgz]
authorXin Li <[email protected]>Sat Feb 20 00:24:22 2021 -0800
committerXin Li <[email protected]>Sat Feb 20 00:24:22 2021 -0800
treeb8437a90846688be84adcc10dbe9584d9689e006
parent82bdb81e892467225de1de647b1ef43b4df3ea77 [diff]
parent21479602c3b9ecf70b65e6d9c26f25cc2e31619c [diff]
Mark ab/7061308 as merged in stage.

Bug: 180401296
Merged-In: I2abeb0fc28b199f2ca8d678cd5641918567926fe
Change-Id: Icf5cb7a738a9e79b32e1a36fed874cafe19adb65
tree: b8437a90846688be84adcc10dbe9584d9689e006
  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.