Google Git
Sign in
android / platform / external / rust / crates / protobuf / 158191ed44106548cab90722232f15ef9ee355a4
commit158191ed44106548cab90722232f15ef9ee355a4[log] [tgz]
authorJeff Vander Stoep <jeffv@google.com>Tue Mar 28 08:00:23 2023 +0200
committerJeff Vander Stoep <jeffv@google.com>Tue Mar 28 08:23:41 2023 +0200
tree1f335bdd78b8ed748166610ffd856da2f1130d58
parenta389dee962e2e8c9edd01919cb729a85be9dbc83 [diff]
Introduce libprotobuf_deprecated

This temporarily introduces a second copy of protobuf 2.27.1 with
soong module name libprotobuf_deprecated. This allows migrating
other projects across various git branches to libprotobuf_deprecated
one-at-a-time until nothing depends on libprotobuf and we can upgrade
that to version 3.2.

Bug: 270895633
Test: build
Change-Id: Ib5102978651ba4999b4e1d3e225ecdce72dbb3c1
88 files changed
tree: 1f335bdd78b8ed748166610ffd856da2f1130d58
  1. 2.27.1/
  2. benches/
  3. out/
  4. src/
  5. LICENSE ⇨ LICENSE.txt
  6. NOTICE ⇨ LICENSE
  7. .cargo_vcs_info.json
  8. Android.bp
  9. build.rs
  10. Cargo.toml
  11. Cargo.toml.orig
  12. cargo2android.json
  13. LICENSE.txt
  14. METADATA
  15. MODULE_LICENSE_MIT
  16. OWNERS
  17. README.md
  18. regenerate.sh
  19. TEST_MAPPING
README.md

Library to read and write protocol buffers data

Version 2 is stable

Currently developed branch of rust-protobuf is 3. It has the same spirit as version 2, but contains numerous improvements like:

  • runtime reflection for mutability, not just for access
  • protobuf text format and JSON parsing (which rely on reflection)
  • dynamic message support: work with protobuf data without generating code from schema

Stable version of rust-protobuf will be supported until version 3 released.

Tracking issue for version 3.

How to generate rust code

There are several ways to generate rust code from .proto files

Invoke protoc programmatically with protoc-rust crate (recommended)

Have a look at readme in protoc-rust crate.

Use pure rust protobuf parser and code generator

Readme should be in protobuf-codegen-pure crate.

Use protoc-gen-rust plugin

Readme is here.

Generated code

Have a look at generated files (for current development version), used internally in rust-protobuf:

Copy on write

Rust-protobuf can be used with bytes crate.

To enable Bytes you need to:

  1. Enable with-bytes feature in rust-protobuf:
[dependencies]
protobuf = { version = "~2.0", features = ["with-bytes"] }
  1. Enable bytes option

with Customize when codegen is invoked programmatically:

protoc_rust::run(protoc_rust::Args {
    ...
    customize: Customize {
        carllerche_bytes_for_bytes: Some(true),
        carllerche_bytes_for_string: Some(true),
        ..Default::default()
    },
});

or in .proto file:

import "rustproto.proto";

option (rustproto.carllerche_bytes_for_bytes_all) = true;
option (rustproto.carllerche_bytes_for_string_all) = true;

With these options enabled, fields of type bytes or string are generated as Bytes or Chars respectively. When CodedInputStream is constructed from Bytes object, fields of these types get subslices of original Bytes object, instead of being allocated on heap.

Accompanying crates