Struct Builder

pub struct Builder { /* private fields */ }

Service generator builder.

Implementations

impl Builder

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

Enable or disable client code generation.

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

Enable or disable server code generation.

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

Enable or disable scale codec extensions generation.

pub fn format(self, run: bool) -> Self

Enable the output to be formated by rustfmt.

pub fn mod_prefix(self, prefix: impl Into<String>) -> Self

Module prefix of the generated code.

pub fn type_prefix(self, prefix: impl Into<String>) -> Self

Type prefix of the scale codec anotation in the proto file.

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

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

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 proto_path(self, proto_path: impl AsRef<str>) -> Self

Set the path to where to search for the Request/Response proto structs live relative to the module where you call include_proto!.

This defaults to super since we will generate code in a module.

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 disable_package_emission(self) -> Self

Emits RPC endpoints with no attached package. Effectively ignores protofile package declaration from rpc context.

This effectively sets prost’s exported package to an empty string.

pub fn disable_service_name_emission(self) -> Self

Disable emitting service name in rpc endpoints.

pub fn keep_service_name(self, name: impl Into<String>) -> Self

Keep the service name in rpc endpoints.

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 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.

pub fn compile( self, protos: &[impl AsRef<Path>], includes: &[impl AsRef<Path>], ) -> Result<()>

Compile the .proto files and execute code generation.

pub fn compile_with_config( self, config: Config, protos: &[impl AsRef<Path>], includes: &[impl AsRef<Path>], ) -> Result<()>

Compile the .proto files and execute code generation using a custom prost_build::Config.

pub fn enable_serde_extension(self) -> Self

Enable serde serialization/deserialization for all generated types. This adds the necessary derives and attributes for serde compatibility.

pub fn compile_dir(self, proto_dir: impl AsRef<Path>) -> Result<()>

Compile all .proto files in the specified directory. The include directory will be the same as the proto directory.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.