Google Git
Sign in
android / platform / external / rust / crates / protobuf-codegen / 4a3a838a31cfc873babe90e70262b4f62eef443e
commit4a3a838a31cfc873babe90e70262b4f62eef443e[log] [tgz]
authorandroid-build-team Robot <[email protected]>Wed Feb 17 03:16:57 2021 +0000
committerandroid-build-team Robot <[email protected]>Wed Feb 17 03:16:57 2021 +0000
treeb8437a90846688be84adcc10dbe9584d9689e006
parent1789c94b6de5256396de879a67fbd24f718fe9f0 [diff]
parent604fa90d9974356058a3463e65d7751b4d9d3241 [diff]
Snap for 7149879 from 604fa90d9974356058a3463e65d7751b4d9d3241 to sc-d1-release

Change-Id: I6d44dc9934f6ce3ede085a7d78c6f98996bca568
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.