Struct grpc_build::Builder

pub struct Builder { /* private fields */ }

A mirror of tonic_build::Builder for our own control

Implementations

impl Builder

pub fn new() -> Self

pub fn force(self, force: bool) -> Self

pub fn follow_links(self, follow_links: bool) -> Self

Follow symbolic links when finding .proto files.

This defaults to false.

pub fn out_dir(self, out_dir: impl AsRef<Path>) -> Self

pub fn default_module_name(self, name: impl AsRef<str>) -> Self

Configures what filename protobufs with no package definition are written to.

pub fn build_client(self, enable: bool) -> Self

Enable or disable gRPC client code generation.

pub fn build_server(self, enable: bool) -> Self

Enable or disable gRPC server code generation.

pub fn extern_path( 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

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

Add additional attribute to matched messages, enums, and one-offs.

Passed directly to prost_build::Config.type_attribute.

pub fn server_mod_attribute<P: AsRef<str>, A: AsRef<str>>( self, path: P, attribute: A ) -> Self

Add additional attribute to matched server mods. Matches on the package name.

pub fn server_attribute<P: AsRef<str>, A: AsRef<str>>( self, path: P, attribute: A ) -> Self

Add additional attribute to matched service servers. Matches on the service name.

pub fn client_mod_attribute<P: AsRef<str>, A: AsRef<str>>( self, path: P, attribute: A ) -> Self

Add additional attribute to matched client mods. Matches on the package name.

pub fn client_attribute<P: AsRef<str>, A: AsRef<str>>( self, path: P, attribute: A ) -> Self

Add additional attribute to matched service clients. Matches on the service name.

pub fn protoc_arg<A: AsRef<str>>(self, arg: A) -> Self

Configure Prost protoc_args build arguments.

Note: Enabling --experimental_allow_proto3_optional requires protobuf >= 3.12.

pub fn compile_well_known_types(self, compile_well_known_types: bool) -> Self

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 include_file(self, path: impl AsRef<Path>) -> Self

Configures the optional module filename for easy inclusion of all generated Rust files

If set, generates a file (inside the OUT_DIR or out_dir() as appropriate) which contains a set of pub mod XXX statements combining to load all Rust files generated. This can allow for a shortcut where multiple related proto files have been compiled together resulting in a semi-complex set of includes.

pub fn file_descriptor_set_path(self, path: impl Into<PathBuf>) -> Self

When set, the FileDescriptorSet generated by protoc is written to the provided filesystem path.

This option can be used in conjunction with the include_bytes! macro and the types in the prost-types crate for implementing reflection capabilities, among other things.

impl Builder

pub fn build(self, in_dir: impl AsRef<Path>) -> Result<(), Error>

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.