Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / protobuf-codegen / 69cd8ed5c5cd03fca2c71380efe002cce08c68ea
commit69cd8ed5c5cd03fca2c71380efe002cce08c68ea[log] [tgz]
authorIvan Lozano <ivanlozano@google.com>Tue Sep 01 00:38:33 2020 +0000
committerGerrit Code Review <noreply-gerritcodereview@google.com>Tue Sep 01 00:38:33 2020 +0000
treeb70eafbe918b3bd19e1825d553c88a1941de9ae7
parent5bc6d397384b7b873b3fd1fb1f6eb572caa3558d [diff]
parentb32d5e8e4cb548d258ce9574103bcd4a912ca24b [diff]
Merge "Allow generated source to be root module src."
tree: b70eafbe918b3bd19e1825d553c88a1941de9ae7
  1. patches/
  2. src/
  3. LICENSE ⇨ LICENSE.txt
  4. NOTICE ⇨ LICENSE
  5. .cargo_vcs_info.json
  6. Android.bp
  7. Cargo.lock
  8. Cargo.toml
  9. Cargo.toml.orig
  10. LICENSE.txt
  11. METADATA
  12. MODULE_LICENSE_BSD_LIKE
  13. OWNERS
  14. README.android
  15. README.md
  16. 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.