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.

Examples found in repository?
examples/file-descriptor-out-compare.rs (line 22)
12fn main() {
13    let args = env::args().skip(1).collect::<Vec<_>>();
14    let args = args.iter().map(|s| s.as_str()).collect::<Vec<_>>();
15    let (path, out_protoc, out_pure) = match args.as_slice() {
16        // Just invoke protoc.
17        [path, out_protoc, out_pure] => (path, out_protoc, out_pure),
18        _ => panic!("wrong args"),
19    };
20
21    for which in [Which::Pure, Which::Protoc] {
22        let mut parser = Parser::new();
23        match which {
24            Which::Protoc => {
25                parser.protoc();
26            }
27            Which::Pure => {
28                parser.pure();
29            }
30        }
31
32        parser.input(path);
33        parser.include(".");
34        let fds = parser.file_descriptor_set().unwrap();
35        let fds = text_format::print_to_string_pretty(&fds);
36        let out = match which {
37            Which::Protoc => out_protoc,
38            Which::Pure => out_pure,
39        };
40        fs::write(out, fds).unwrap();
41    }
42}
Source

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

Use pure rust parser.

Examples found in repository?
examples/file-descriptor-out-compare.rs (line 28)
12fn main() {
13    let args = env::args().skip(1).collect::<Vec<_>>();
14    let args = args.iter().map(|s| s.as_str()).collect::<Vec<_>>();
15    let (path, out_protoc, out_pure) = match args.as_slice() {
16        // Just invoke protoc.
17        [path, out_protoc, out_pure] => (path, out_protoc, out_pure),
18        _ => panic!("wrong args"),
19    };
20
21    for which in [Which::Pure, Which::Protoc] {
22        let mut parser = Parser::new();
23        match which {
24            Which::Protoc => {
25                parser.protoc();
26            }
27            Which::Pure => {
28                parser.pure();
29            }
30        }
31
32        parser.input(path);
33        parser.include(".");
34        let fds = parser.file_descriptor_set().unwrap();
35        let fds = text_format::print_to_string_pretty(&fds);
36        let out = match which {
37            Which::Protoc => out_protoc,
38            Which::Pure => out_pure,
39        };
40        fs::write(out, fds).unwrap();
41    }
42}
Source

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

Use protoc for parsing.

Examples found in repository?
examples/file-descriptor-out-compare.rs (line 25)
12fn main() {
13    let args = env::args().skip(1).collect::<Vec<_>>();
14    let args = args.iter().map(|s| s.as_str()).collect::<Vec<_>>();
15    let (path, out_protoc, out_pure) = match args.as_slice() {
16        // Just invoke protoc.
17        [path, out_protoc, out_pure] => (path, out_protoc, out_pure),
18        _ => panic!("wrong args"),
19    };
20
21    for which in [Which::Pure, Which::Protoc] {
22        let mut parser = Parser::new();
23        match which {
24            Which::Protoc => {
25                parser.protoc();
26            }
27            Which::Pure => {
28                parser.pure();
29            }
30        }
31
32        parser.input(path);
33        parser.include(".");
34        let fds = parser.file_descriptor_set().unwrap();
35        let fds = text_format::print_to_string_pretty(&fds);
36        let out = match which {
37            Which::Protoc => out_protoc,
38            Which::Pure => out_pure,
39        };
40        fs::write(out, fds).unwrap();
41    }
42}
Source

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

Add an include directory.

Examples found in repository?
examples/file-descriptor-out-compare.rs (line 33)
12fn main() {
13    let args = env::args().skip(1).collect::<Vec<_>>();
14    let args = args.iter().map(|s| s.as_str()).collect::<Vec<_>>();
15    let (path, out_protoc, out_pure) = match args.as_slice() {
16        // Just invoke protoc.
17        [path, out_protoc, out_pure] => (path, out_protoc, out_pure),
18        _ => panic!("wrong args"),
19    };
20
21    for which in [Which::Pure, Which::Protoc] {
22        let mut parser = Parser::new();
23        match which {
24            Which::Protoc => {
25                parser.protoc();
26            }
27            Which::Pure => {
28                parser.pure();
29            }
30        }
31
32        parser.input(path);
33        parser.include(".");
34        let fds = parser.file_descriptor_set().unwrap();
35        let fds = text_format::print_to_string_pretty(&fds);
36        let out = match which {
37            Which::Protoc => out_protoc,
38            Which::Pure => out_pure,
39        };
40        fs::write(out, fds).unwrap();
41    }
42}
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

Examples found in repository?
examples/file-descriptor-out-compare.rs (line 32)
12fn main() {
13    let args = env::args().skip(1).collect::<Vec<_>>();
14    let args = args.iter().map(|s| s.as_str()).collect::<Vec<_>>();
15    let (path, out_protoc, out_pure) = match args.as_slice() {
16        // Just invoke protoc.
17        [path, out_protoc, out_pure] => (path, out_protoc, out_pure),
18        _ => panic!("wrong args"),
19    };
20
21    for which in [Which::Pure, Which::Protoc] {
22        let mut parser = Parser::new();
23        match which {
24            Which::Protoc => {
25                parser.protoc();
26            }
27            Which::Pure => {
28                parser.pure();
29            }
30        }
31
32        parser.input(path);
33        parser.include(".");
34        let fds = parser.file_descriptor_set().unwrap();
35        let fds = text_format::print_to_string_pretty(&fds);
36        let out = match which {
37            Which::Protoc => out_protoc,
38            Which::Pure => out_pure,
39        };
40        fs::write(out, fds).unwrap();
41    }
42}
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.

Examples found in repository?
examples/file-descriptor-out-compare.rs (line 34)
12fn main() {
13    let args = env::args().skip(1).collect::<Vec<_>>();
14    let args = args.iter().map(|s| s.as_str()).collect::<Vec<_>>();
15    let (path, out_protoc, out_pure) = match args.as_slice() {
16        // Just invoke protoc.
17        [path, out_protoc, out_pure] => (path, out_protoc, out_pure),
18        _ => panic!("wrong args"),
19    };
20
21    for which in [Which::Pure, Which::Protoc] {
22        let mut parser = Parser::new();
23        match which {
24            Which::Protoc => {
25                parser.protoc();
26            }
27            Which::Pure => {
28                parser.pure();
29            }
30        }
31
32        parser.input(path);
33        parser.include(".");
34        let fds = parser.file_descriptor_set().unwrap();
35        let fds = text_format::print_to_string_pretty(&fds);
36        let out = match which {
37            Which::Protoc => out_protoc,
38            Which::Pure => out_pure,
39        };
40        fs::write(out, fds).unwrap();
41    }
42}

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