#protobuf #serialization

bin+lib protobuf-codegen3

Code generator for rust-protobuf. Includes a library and protoc-gen-rust binary. See protoc-rust and protobuf-codegen-pure crates

3 stable releases

Uses old Rust 2015

2.28.2 Feb 27, 2023
2.28.1 Feb 24, 2023
2.27.2 Sep 7, 2022

#751 in Encoding

Download history 43/week @ 2023-08-15 63/week @ 2023-08-22 67/week @ 2023-08-29 85/week @ 2023-09-05 76/week @ 2023-09-12 42/week @ 2023-09-19 71/week @ 2023-09-26 18/week @ 2023-10-03 39/week @ 2023-10-10 68/week @ 2023-10-17 41/week @ 2023-10-24 65/week @ 2023-10-31 50/week @ 2023-11-07 44/week @ 2023-11-14 107/week @ 2023-11-21 44/week @ 2023-11-28

250 downloads per month
Used in 2 crates (via protobuf-codegen-pure3)

MIT license

33K SLoC

Protobuf code generator

This crate contains protobuf code generator implementation and a protoc-gen-rust protoc plugin.

This crate:

  • provides protoc-gen-rust plugin for protoc command
  • implement protobuf codegen

This crate is not meant to be used directly, in fact, it does not provide any public API (except for protoc-gen-rust binary).

Code can be generated with either:

  • protoc-gen-rust plugin for protoc or
  • protoc-rust crate (code generator which depends on protoc binary for parsing of .proto files)
  • protobuf-codegen-pure crate, similar API to protoc-rust, but uses pure rust parser of .proto files.

protoc-gen-rust plugin for protoc

When non-cargo build system is used, consider using standard protobuf code generation pattern: protoc command does all the work of handling paths and parsing .proto files. When protoc is invoked with --rust_out= option, it invokes protoc-gen-rust plugin. provided by this crate.

When building with cargo, consider using protoc-rust or protobuf-codegen-pure crates.

How to use protoc-gen-rust if you have to

(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

  1. Generate .rs files:
protoc --rust_out . foo.proto

This will generate .rs files in current directory.

Version 2

This is documentation for version 2 of the crate.

Version 3 of the crate (currently in development) encapsulates both protoc and pure codegens in this crate.