Struct tonic_build::Builder [−][src]
Service generator builder.
Implementations
impl Builder
[src]
pub fn build_client(self, enable: bool) -> Self
[src]
Enable or disable gRPC client code generation.
pub fn build_server(self, enable: bool) -> Self
[src]
Enable or disable gRPC server code generation.
pub fn file_descriptor_set_path(self, path: impl AsRef<Path>) -> Self
[src]
Generate a file containing the encoded prost_types::FileDescriptorSet
for protocol buffers
modules. This is required for implementing gRPC Server Reflection.
pub fn format(self, run: bool) -> Self
[src]
Enable the output to be formated by rustfmt.
pub fn out_dir(self, out_dir: impl AsRef<Path>) -> Self
[src]
Set the output directory to generate code to.
Defaults to the OUT_DIR
environment variable.
pub fn extern_path(
self,
proto_path: impl AsRef<str>,
rust_path: impl AsRef<str>
) -> Self
[src]
self,
proto_path: impl AsRef<str>,
rust_path: impl AsRef<str>
) -> Self
Declare externally provided Protobuf package or type.
Passed directly to prost_build::Config.extern_path
.
Note that both the Protobuf path and the rust package paths should both be fully qualified.
i.e. Protobuf paths should start with “.” and rust paths should start with “::”
pub fn field_attribute<P: AsRef<str>, A: AsRef<str>>(
self,
path: P,
attribute: A
) -> Self
[src]
self,
path: P,
attribute: A
) -> Self
Add additional attribute to matched messages, enums, and one-offs.
Passed directly to prost_build::Config.field_attribute
.
pub fn type_attribute<P: AsRef<str>, A: AsRef<str>>(
self,
path: P,
attribute: A
) -> Self
[src]
self,
path: P,
attribute: A
) -> Self
Add additional attribute to matched messages, enums, and one-offs.
Passed directly to prost_build::Config.type_attribute
.
pub fn proto_path(self, proto_path: impl AsRef<str>) -> Self
[src]
Set the path to where tonic will search for the Request/Response proto structs
live relative to the module where you call include_proto!
.
This defaults to super
since tonic will generate code in a module.
pub fn disable_package_emission(self) -> Self
[src]
Emits GRPC endpoints with no attached package. Effectively ignores protofile package declaration from grpc context.
This effectively sets prost’s exported package to an empty string.
pub fn compile_well_known_types(self, compile_well_known_types: bool) -> Self
[src]
Enable or disable directing Prost to compile well-known protobuf types instead
of using the already-compiled versions available in the prost-types
crate.
This defaults to false
.
pub fn compile<P>(self, protos: &[P], includes: &[P]) -> Result<()> where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
Compile the .proto files and execute code generation.
pub fn compile_with_config<P>(
self,
config: Config,
protos: &[P],
includes: &[P]
) -> Result<()> where
P: AsRef<Path>,
[src]
self,
config: Config,
protos: &[P],
includes: &[P]
) -> Result<()> where
P: AsRef<Path>,
Compile the .proto files and execute code generation using a
custom prost_build::Config
.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Builder
impl Send for Builder
impl Sync for Builder
impl Unpin for Builder
impl UnwindSafe for Builder
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,