Struct Codegen

pub struct Codegen { /* private fields */ }

Entry point for .proto to .rs code generation.

This is similar to protoc --rs_out....

Implementations

impl Codegen

pub fn new() -> Self

Create new codegen object.

Uses protoc from $PATH by default.

Can be switched to pure rust parser using pure function.

pub fn pure(&mut self) -> &mut Self

Switch to pure Rust parser of .proto files.

pub fn protoc(&mut self) -> &mut Self

Switch to protoc parser of .proto files.

pub fn out_dir(&mut self, out_dir: impl AsRef<Path>) -> &mut Self

Output directory for generated code.

When invoking from build.rs, consider using cargo_out_dir instead.

pub fn cargo_out_dir(&mut self, rel: &str) -> &mut Self

Set output directory relative to Cargo output dir.

With this option, output directory is erased and recreated during invocation.

pub fn include(&mut self, include: impl AsRef<Path>) -> &mut Self

Add an include directory.

pub fn includes( &mut self, includes: impl IntoIterator<Item = impl AsRef<Path>>, ) -> &mut Self

Add include directories.

pub fn input(&mut self, input: impl AsRef<Path>) -> &mut Self

Append a .proto file path to compile

pub fn inputs( &mut self, inputs: impl IntoIterator<Item = impl AsRef<Path>>, ) -> &mut Self

Append multiple .proto file paths to compile

pub fn protoc_path(&mut self, protoc: &Path) -> &mut Self

Specify protoc command path to be used when invoking code generation.

Examples

use protobuf_codegen::Codegen;

Codegen::new()
    .protoc()
    .protoc_path(&protoc_bin_vendored::protoc_bin_path().unwrap())
    // ...
    .run()
    .unwrap();

This option is ignored when pure Rust parser is used.

pub fn capture_stderr(&mut self) -> &mut Self

Capture stderr to error when running protoc.

pub fn protoc_extra_arg(&mut self, arg: impl Into<OsString>) -> &mut Self

Extra command line flags for protoc invocation.

For example, --experimental_allow_proto3_optional option.

This option is ignored when pure Rust parser is used.

pub fn customize(&mut self, customize: Customize) -> &mut Self

Set options to customize code generation

pub fn customize_callback( &mut self, callback: impl CustomizeCallback, ) -> &mut Self

Callback for dynamic per-element customization.

pub fn run(&self) -> Result<()>

Invoke the code generation.

This is roughly equivalent to protoc --rs_out=... but without requiring protoc-gen-rs command in $PATH.

This function uses pure Rust parser or protoc parser depending on how this object was configured.

pub fn run_from_script(&self)

Similar to run, but prints the message to stderr and exits the process on error.

Trait Implementations

impl Debug for Codegen

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

Formats the value using the given formatter.

impl Default for Codegen

fn default() -> Codegen

Returns the “default value” for a type.