1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
//! A rust implementation of the protobuf compiler.
//!
//! For convenient compilation of protobuf source files in a single function, see
//! [`compile()`]. For more options see [`Compiler`].
//!
//! # Examples
//!
//! Usage with [`prost-build`](https://crates.io/crates/prost-build):
//!
//! ```
//! # use std::{env, fs, path::PathBuf};
//! # use prost::Message;
//! # let tempdir = tempfile::TempDir::new().unwrap();
//! # env::set_current_dir(&tempdir).unwrap();
//! # env::set_var("OUT_DIR", tempdir.path());
//! # fs::write("root.proto", "").unwrap();
//! let file_descriptors = protox::compile(["root.proto"], ["."]).unwrap();
//! prost_build::compile_fds(file_descriptors).unwrap();
//! ```
//!
//! Usage with [`tonic-build`](https://crates.io/crates/tonic-build):
//!
//! ```rust,ignore
//! # use std::{env, fs, path::PathBuf};
//! # let tempdir = tempfile::TempDir::new().unwrap();
//! # env::set_current_dir(&tempdir).unwrap();
//! # env::set_var("OUT_DIR", tempdir.path());
//! # fs::write("root.proto", "").unwrap();
//! use protox::prost::Message;
//!
//! let file_descriptors = protox::compile(["root.proto"], ["."]).unwrap();
//!
//! tonic_build::configure()
//! .build_server(true)
//! .compile_fds(file_descriptors)
//! .unwrap();
//! ```
//!
//! ### Error messages
//!
//! This crate uses [`miette`](https://crates.io/crates/miette) to add additional details to errors. For nice error messages, add `miette` as a dependency with the `fancy` feature enabled and return a [`miette::Result`](https://docs.rs/miette/latest/miette/type.Result.html) from your build script.
//!
//! ```rust
//! # use std::{env, fs, path::PathBuf};
//! fn main() -> miette::Result<()> {
//! # let tempdir = tempfile::TempDir::new().unwrap();
//! # env::set_current_dir(&tempdir).unwrap();
//! # env::set_var("OUT_DIR", tempdir.path());
//! # fs::write("root.proto", "").unwrap();
//! let _ = protox::compile(["root.proto"], ["."])?;
//!
//! Ok(())
//! }
//! ```
//!
//! Example error message:
//!
//! ```text
//! Error:
//! × name 'Bar' is not defined
//! ╭─[root.proto:3:1]
//! 3 │ message Foo {
//! 4 │ Bar bar = 1;
//! · ─┬─
//! · ╰── found here
//! 5 │ }
//! ╰────
//! ```
use Path;
pub use ;
pub use Compiler;
pub use Error;
/// 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:
///
/// ```rust
/// # use protox::Compiler;
/// # fn main() -> Result<(), protox::Error> {
/// # let files: Vec<std::path::PathBuf> = vec![];
/// # let includes: Vec<std::path::PathBuf> = vec![".".into()];
/// let file_descriptor_set = Compiler::new(includes)?
/// .include_source_info(true)
/// .include_imports(true)
/// .open_files(files)?
/// .file_descriptor_set();
/// # Ok(())
/// # }
/// ```
///
/// # Examples
///
/// ```
/// # use std::fs;
/// # use prost_types::{
/// # DescriptorProto, FieldDescriptorProto, field_descriptor_proto::{Label, Type}, FileDescriptorSet, FileDescriptorProto,
/// # SourceCodeInfo, source_code_info::Location
/// # };
/// # use protox::compile;
/// # let tempdir = tempfile::TempDir::new().unwrap();
/// # std::env::set_current_dir(&tempdir).unwrap();
/// #
/// 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()
/// });
/// ```