Struct protox::Compiler

pub struct Compiler { /* private fields */ }

Options for compiling protobuf files.

Examples

fs::write("bar.proto", "
    message Bar { }
").unwrap();

let file_descriptor_set = Compiler::new(["."])?
    .include_imports(true)
    .include_source_info(false)
    .open_file("bar.proto")?
    .file_descriptor_set();

assert_eq!(file_descriptor_set.file[0].message_type[0].name(), "Bar");

Implementations

impl Compiler

pub fn new<I, P>(includes: I) -> Result<Self, Error>

where I: IntoIterator<Item = P>, P: AsRef<Path>,

Creates a new Compiler with default options and the given set of include paths.

In addition to the given include paths, the Compiler instance will be able to import standard files like google/protobuf/descriptor.proto.

pub fn with_file_resolver<R>(resolver: R) -> Self

where R: FileResolver + 'static,

Creates a new Compiler with a custom FileResolver for looking up imported files.

pub fn include_source_info(&mut self, yes: bool) -> &mut Self

Sets whether the output FileDescriptorSet should include source info.

If set, the file descriptors returned by file_descriptor_set will have the FileDescriptorProto::source_code_info field populated with source locations and comments.

pub fn include_imports(&mut self, yes: bool) -> &mut Self

Sets whether the output FileDescriptorSet should include imported files.

By default, only files explicitly added with open_file are returned by file_descriptor_set. If this option is set, imported files are included too.

pub fn open_file(&mut self, path: impl AsRef<Path>) -> Result<&mut Self, Error>

Compiles the file at the given path, and adds it to this Compiler instance.

If the path is absolute, or relative to the current directory, it must reside under one of the include paths. Otherwise, it is looked up relative to the given include paths in the same way as import statements.

pub fn open_files( &mut self, paths: impl IntoIterator<Item = impl AsRef<Path>> ) -> Result<&mut Self, Error>

Compiles the given files, and adds them to this Compiler instance.

See open_file().

pub fn file_descriptor_set(&self) -> FileDescriptorSet

Converts all added files into an instance of FileDescriptorSet.

Files are sorted topologically, with dependency files ordered before the files that import them.

pub fn encode_file_descriptor_set(&self) -> Vec<u8>

Converts all added files into an instance of FileDescriptorSet and encodes it.

This is equivalent to file_descriptor_set()?.encode_to_vec(), with the exception that extension options are included.

pub fn descriptor_pool(&self) -> DescriptorPool

Gets a copy of the DescriptorPool containing all referenced files.

pub fn files(&self) -> impl ExactSizeIterator<Item = &FileMetadata>

Gets a reference to all imported source files.

The files will appear in topological order, so each file appears before any file that imports it.

Trait Implementations

impl Debug for Compiler

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

Formats the value using the given formatter.