Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / rust / crates / protobuf-codegen / fdcf7c808165493ea6e99da06b5a1bfe6c5ef3d5
commitfdcf7c808165493ea6e99da06b5a1bfe6c5ef3d5[log] [tgz]
authorJoel Galenson <jgalenson@google.com>Thu Oct 28 13:57:06 2021 -0700
committerJoel Galenson <jgalenson@google.com>Thu Oct 28 14:02:04 2021 -0700
tree20d23f98afdddc14045d4d2c40896f389a5b7592
parentdafb9684c423543957a43185916251d0a88a5376 [diff]
Remove deprecated file.

This readme talked about updating the version number, but this is now
handled by cargo2android.py and the cargo_pkg_version field in the
Android.bp file.

It also warns about rerunning cargo2android.py and verifying changes
caused by build.rs, but that's true for other crates, so this doesn't
seem required, although it could potentially still have value.

Test: None
Change-Id: I3fe74b3acd40b80fca4e1cc71e7067daf872d99f
1 file changed
tree: 20d23f98afdddc14045d4d2c40896f389a5b7592
  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.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.