Struct exonum_build::ProtobufGenerator

pub struct ProtobufGenerator<'a> { /* fields omitted */ }

Generates Rust modules from Protobuf files.

The protoc executable (i.e., the Protobuf compiler) should be in $PATH.

Examples

Specify in the build script (build.rs) of your crate:

use exonum_build::ProtobufGenerator;

ProtobufGenerator::with_mod_name("example_mod.rs")
    .with_input_dir("src/proto")
    .with_crypto()
    .with_common()
    .with_merkledb()
    .generate();

After the successful run, $OUT_DIR will contain a module for each Protobuf file in src/proto and example_mod.rs which will include all generated modules as submodules.

To use the generated Rust types corresponding to Protobuf messages, specify in src/proto/mod.rs:

include!(concat!(env!("OUT_DIR"), "/example_mod.rs"));

// If you use types from `exonum` .proto files.
use exonum::proto::schema::*;

Methods

impl<'a> ProtobufGenerator<'a>

pub fn with_mod_name(mod_name: &'a str) -> Self

Name of the rust module generated from input proto files.

Panics

If the mod_name is empty.

pub fn with_input_dir(self, path: &'a str) -> Self

A directory containing input protobuf files. For single mod_name you can provide only one input directory, If proto-files in the input directory have dependencies located in another directories, you must specify them using add_path method.

Predefined dependencies can be specified using corresponding methods with_common, with_crypto, with_exonum.

Panics

If the input directory is already specified.

pub fn add_path(self, path: &'a str) -> Self

An additional directory containing dependent proto-files, can be used multiple times.

pub fn with_common(self) -> Self

Common types for all crates.

pub fn with_crypto(self) -> Self

Proto files from exonum-crypto crate (Hash, PublicKey, etc.).

pub fn with_merkledb(self) -> Self

Proto files from exonum-merkledb crate (MapProof, ListProof).

pub fn with_exonum(self) -> Self

Exonum core related proto files,

pub fn with_includes(self, includes: &'a [ProtoSources]) -> Self

Add multiple include directories.

pub fn without_sources(self) -> Self

Switches off inclusion of source Protobuf files into the generated output.

pub fn generate(self)

Generate proto files from specified sources.

Panics

If the input_dir or includes are empty.

Trait Implementations

impl<'a> Debug for ProtobufGenerator<'a>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.