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
/*
*
* Copyright 2025 gRPC authors.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
* sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
* IN THE SOFTWARE.
*
*/
/// Includes generated proto message, client, and server code.
///
/// You must specify the path to the `.proto` file **relative to the proto root
/// directory**, without the `.proto` extension.
///
/// For example, if your proto directory is `path/to/protos` and it contains the
/// file `helloworld.proto`, you would write:
///
/// ```rust,ignore
/// mod pb {
/// grpc::include_proto!("path/to/protos", "helloworld");
/// }
/// ```
///
/// # Note
/// **This macro only works if the gRPC build output directory and message path
/// are unmodified.** By default:
/// - The output directory is set to the [`OUT_DIR`] environment variable.
/// - The message path is set to `self`.
///
/// If your `.proto` files are not in a subdirectory, you can omit the first
/// parameter.
///
/// ```rust,ignore
/// mod pb {
/// grpc::include_proto!("helloworld");
/// }
/// ```
///
/// If you have modified the output directory or message path, you should use
/// the include_generated_proto macro below instead of using this macro or
/// manually include it yourself.
///
/// ```rust,ignore
/// mod grpc {
/// grpc::include_generated_proto!("path/to/protos", "helloworld");
/// }
/// ```
///
/// The following example assumes the message code is imported using `self`:
///
/// ```rust,ignore
/// mod protos {
/// // Include message code.
/// include!("relative/protobuf/directory/generated.rs");
///
/// // Include service code.
/// include!("relative/protobuf/directory/helloworld_grpc.pb.rs");
/// }
/// ```
///
/// If the message code and service code are in different modules, and the
/// message path specified during code generation is `super::protos`, use:
///
/// ```rust,ignore
/// mod protos {
/// // Include message code.
/// include!("relative/protobuf/directory/generated.rs");
/// }
///
/// mod grpc {
/// // Include service code.
/// include!("relative/protobuf/directory/helloworld_grpc.pb.rs");
/// }
/// ```
///
/// [`OUT_DIR`]:
/// https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts
/// Includes generated proto message, client, and server code. This macro is for
/// if you manually set output_dir instead of using the default OUT_DIR.
///
/// You must specify the path to the `.proto` file **relative to the proto root
/// directory**, without the `.proto` extension.
///
/// For example, if your proto directory is `path/to/protos` and it contains the
/// file `helloworld.proto`, you would write:
///
/// ```rust,ignore
/// mod pb {
/// grpc::include_generated_proto!("path/to/protos", "helloworld");
/// }
/// ```
///
/// If your `.proto` files are not in a subdirectory, you can omit the first
/// parameter.
///
/// ```rust,ignore
/// mod pb {
/// grpc::include_generated_proto!("helloworld");
/// }
/// ```
///
/// [`CARGO_MANIFEST_DIR`]:
/// https://doc.rust-lang.org/cargo/reference/environment-variables.html