README.md
1<!-- cargo-sync-readme start -->
2
3# Library to read and write protocol buffers data
4
5## Features
6
7This crate has one feature, which is `with-bytes`.
8
9`with-bytes` enables `protobuf` crate support for
10[`bytes` crate](https://github.com/tokio-rs/bytes):
11when parsing bytes or strings from `bytes::Bytes`,
12`protobuf` will be able to reference the input instead of allocating subarrays.
13
14Note, codegen also need to be instructed to generate `Bytes` or `Chars` for
15`bytes` or `string` protobuf types instead of default `Vec<u8>` or `String`,
16just enabling option on this crate is not enough.
17
18See `Customize` struct in [`protobuf-codegen` crate](https://docs.rs/protobuf-codegen).
19
20## Accompanying crates
21
22* [`protobuf-json-mapping`](https://docs.rs/protobuf-json-mapping)
23 implements JSON parsing and serialization for protobuf messages.
24* [`protobuf-codegen`](https://docs.rs/protobuf-codegen)
25 can be used to rust code from `.proto` crates.
26* [`protoc-bin-vendored`](https://docs.rs/protoc-bin-vendored)
27 contains `protoc` command packed into the crate.
28* [`protobuf-parse`](https://docs.rs/protobuf-parse) contains
29 `.proto` file parser. Rarely need to be used directly,
30 but can be used for mechanical processing of `.proto` files.
31
32<!-- cargo-sync-readme end -->
33