protobuf_parse

Struct Parser

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

Configure and invoke .proto parser.

Implementations§

Source§

impl Parser

Source

pub fn new() -> Parser

Create new default configured parser.

Source

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

Use pure rust parser.

Source

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

Use protoc for parsing.

Source

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

Add an include directory.

Source

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

Add include directories.

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: &Path) -> &mut Self

Specify protoc path used for parsing.

This is ignored if pure rust parser is used.

Source

pub fn protoc_extra_args( &mut self, args: impl IntoIterator<Item = impl AsRef<OsStr>>, ) -> &mut Self

Extra arguments to pass to protoc command (like experimental options).

This is ignored if pure rust parser is used.

Source

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

Capture stderr and return it in error.

This option applies only to protoc parser. By default protoc stderr is inherited from this process stderr.

Source

pub fn parse_and_typecheck(&self) -> Result<ParsedAndTypechecked>

Parse .proto files and typecheck them using pure Rust parser of protoc command.

Source

pub fn file_descriptor_set(&self) -> Result<FileDescriptorSet>

Parse and convert result to FileDescriptorSet.

Trait Implementations§

Source§

impl Debug for Parser

Source§

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

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

impl Default for Parser

Source§

fn default() -> Parser

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

Auto Trait Implementations§

§

impl Freeze for Parser

§

impl RefUnwindSafe for Parser

§

impl Send for Parser

§

impl Sync for Parser

§

impl Unpin for Parser

§

impl UnwindSafe for Parser

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, 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.