pub fn compile(
files: impl IntoIterator<Item = impl AsRef<Path>>,
includes: impl IntoIterator<Item = impl AsRef<Path>>,
) -> Result<FileDescriptorSet, Error>
Expand description
Compiles a set of protobuf files using the given include paths.
For more control over how files are compiled, see Compiler
. This function is equivalent to:
let file_descriptor_set = Compiler::new(includes)?
.include_source_info(true)
.include_imports(true)
.open_files(files)?
.file_descriptor_set();
ยงExamples
fs::write("bar.proto", "
message Bar { }
").unwrap();
fs::write("root.proto", "
import 'bar.proto';
message Foo {
optional Bar bar = 1;
}
").unwrap();
assert_eq!(compile(["root.proto"], ["."]).unwrap(), FileDescriptorSet {
file: vec![
FileDescriptorProto {
name: Some("bar.proto".to_owned()),
message_type: vec![DescriptorProto {
name: Some("Bar".to_owned()),
..Default::default()
}],
source_code_info: Some(SourceCodeInfo {
location: vec![
Location { path: vec![], span: vec![1, 4, 19], ..Default::default() },
Location { path: vec![4, 0], span: vec![1, 4, 19], ..Default::default() },
Location { path: vec![4, 0, 1], span: vec![1, 12, 15], ..Default::default() },
],
}),
..Default::default()
},
FileDescriptorProto {
name: Some("root.proto".to_owned()),
dependency: vec!["bar.proto".to_owned()],
message_type: vec![DescriptorProto {
name: Some("Foo".to_owned()),
field: vec![FieldDescriptorProto {
name: Some("bar".to_owned()),
number: Some(1),
label: Some(Label::Optional as _),
r#type: Some(Type::Message as _),
type_name: Some(".Bar".to_owned()),
json_name: Some("bar".to_owned()),
..Default::default()
}],
..Default::default()
}],
source_code_info: Some(SourceCodeInfo {
location: vec![
Location { path: vec![], span: vec![1, 4, 5, 5], ..Default::default() },
Location { path: vec![3, 0], span: vec![1, 4, 23], ..Default::default() },
Location { path: vec![4, 0], span: vec![3, 4, 5, 5], ..Default::default() },
Location { path: vec![4, 0, 1], span: vec![3, 12, 15], ..Default::default() },
Location { path: vec![4, 0, 2, 0], span: vec![4, 8, 29], ..Default::default() },
Location { path: vec![4, 0, 2, 0, 1], span: vec![4, 21, 24], ..Default::default() },
Location { path: vec![4, 0, 2, 0, 3], span: vec![4, 27, 28], ..Default::default() },
Location { path: vec![4, 0, 2, 0, 4], span: vec![4, 8, 16], ..Default::default() },
Location { path: vec![4, 0, 2, 0, 6], span: vec![4, 17, 20], ..Default::default() },
],
}),
..Default::default()
},
],
..Default::default()
});