Struct Codegen

Source
pub struct Codegen { /* private fields */ }
Expand description

Protoc --rust_out... args

Implementations§

Source§

impl Codegen

Source

pub fn new() -> Self

Arguments to the protoc found in $PATH

Source

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

Set --LANG_out=... param

Source

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

Append a path to -I args

Source

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

Append multiple paths to -I args

Source

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

Append a .proto file path to compile

Source

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

Append multiple .proto file paths to compile

Source

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();
Source

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

Set options to customize code generation

Source

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

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

Trait Implementations§

Source§

impl Debug for Codegen

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Codegen

Source§

fn default() -> Codegen

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.