Struct protoc_rust::Codegen

pub struct Codegen { /* fields omitted */ }

Protoc --rust_out... args

Implementations

impl Codegen

pub fn new() -> Self

Arguments to the protoc found in $PATH

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

Set --LANG_out=... param

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

Append a path to -I args

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

Append multiple paths to -I args

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: impl Into<PathBuf>) -> &mut Self

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

Examples

use protoc_rust::Codegen;

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

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

Set options to customize code generation

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

Extra command line flags for protoc invocation.

For example, --experimental_allow_proto3_optional option.

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

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

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.