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
/// Include generated proto server and client items. /// /// You must specify the gRPC package name. /// /// ```rust,ignore /// mod pb { /// tonic::include_proto!("helloworld"); /// } /// ``` /// /// # Note: /// **This only works if the tonic-build output directory has been unmodified**. /// The default output directory is set to the [`OUT_DIR`] environment variable. /// If the output directory has been modified, the following pattern may be used /// instead of this macro. /// /// ```rust,ignore /// mod pb { /// include!("/relative/protobuf/directory/helloworld.rs"); /// } /// ``` /// You can also use a custom environment variable using the following pattern. /// ```rust,ignore /// mod pb { /// include!(concat!(env!("PROTOBUFS"), "/helloworld.rs")); /// } /// ``` /// /// [`OUT_DIR`]: https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts #[macro_export] macro_rules! include_proto { ($package: tt) => { include!(concat!(env!("OUT_DIR"), concat!("/", $package, ".rs"))); }; } /// Include an encoded `prost_types::FileDescriptorSet` as a `&'static [u8]`. The parameter must be /// the stem of the filename passed to `file_descriptor_set_path` for the `tonic-build::Builder`, /// excluding the `.bin` extension. /// /// For example, a file descriptor set compiled like this in `build.rs`: /// /// ```rust,ignore /// let descriptor_path = PathBuf::from(env::var("OUT_DIR").unwrap()).join("my_descriptor.bin") /// tonic_build::configure() /// .file_descriptor_set_path(&descriptor_path) /// .format(true) /// .compile(&["proto/reflection.proto"], &["proto/"])?; /// ``` /// /// Can be included like this: /// /// ```rust,ignore /// mod pb { /// pub(crate) const FILE_DESCRIPTOR_SET: &[u8] = tonic::include_file_descriptor_set!("my_descriptor"); /// } /// ``` /// /// # Note: /// **This only works if the tonic-build output directory has been unmodified**. /// The default output directory is set to the [`OUT_DIR`] environment variable. /// If the output directory has been modified, the following pattern may be used /// instead of this macro. /// /// ```rust,ignore /// mod pb { /// pub(crate) const FILE_DESCRIPTOR_SET: &[u8] = include_bytes!("/relative/protobuf/directory/descriptor_name.bin"); /// } /// ``` #[macro_export] macro_rules! include_file_descriptor_set { ($package: tt) => { include_bytes!(concat!(env!("OUT_DIR"), concat!("/", $package, ".bin"))) }; }