Struct protoc::Protoc

pub struct Protoc { /* fields omitted */ }

A builder for a protobuf compilation.

Implementations

impl Protoc

pub fn new() -> Self

Starts a new compilation.

pub fn include<S>(&mut self, include: S) -> &mut Self where
    S: Into<PathBuf>, 

Adds an include path to the compilation.

pub fn input<S>(&mut self, input: S) -> &mut Self where
    S: Into<PathBuf>, 

Adds an input file to the compilation.

pub fn serde(&mut self, set: bool) -> &mut Self

Enables or disables serde support.

pub fn compile_into(&mut self, out_dir: &Path) -> Result<(), Error>

Executes the compilation.

The generated files are placed into out_dir according to the conventions of the [protoc_codegen_pure]. Rougly speaking, for each input file path/to/file.proto, this method generates the Rust file OUT_DIR/path/to/file.rs. The details involve some special rules for escaping Rust keywords and special characters, but you will have to consult the protoc_codegen_pure source code for details.

pub fn build_script_exec(&mut self) -> !

Executes the compilation, following build script conventions for input and output.

This is roughly equivalent to calling compile_into, with the following adjustments.

• The directory to generate into is read from the environment variable OUT_DIR.

• If an error occurs, instead of returning the error, the error is printed to stderr and the process is aborted.

• If the compilation is Serde-enabled, Cargo will be instructed to enable the with-serde feature to work around a bug in protobuf_codegen_pure.

• Various diagnostic information is printed to stdout for users following along with e.g. cargo build -vv.

Trait Implementations

impl Debug for Protoc

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

Formats the value using the given formatter.

impl Default for Protoc

fn default() -> Protoc

Returns the "default value" for a type.