Crate protoc_rust

Expand description

API to generate `.rs` files using `protoc` to parse files

This API requires protoc command present in $PATH or explicitly passed to Codegen object (but protoc plugin is not needed).

extern crate protoc_rust;

fn main() {
    protoc_rust::Codegen::new()
        .out_dir("src/protos")
        .inputs(&["protos/a.proto", "protos/b.proto"])
        .include("protos")
        .run()
        .expect("Running protoc failed.");
}

and in build.rs:

[build-dependencies]
protoc-rust = "2"

It is advisable that protoc-rust build-dependency version be the same as protobuf dependency.

The alternative is to use protobuf-codegen-pure crate.

Protoc binary

This crate searches for protoc binary in $PATH by default.

protoc binary can be obtained using protoc-bin-vendored crate and supplied to Codegen object.

This is version 2

In branch 3 of rust-protobuf this functionality is provided by protobuf-codegen crate.

Structs

ArgsDeprecated

Protoc --rust_out... args

Codegen

Protoc --rust_out... args

Customize

Specifies style of generated code.

Functions

runDeprecated

Like protoc --rust_out=... but without requiring protoc-gen-rust command in $PATH.

Type Definitions

Error

Alias for io::Error

Result