Struct RamaTtrpcProtoBuilder 

pub struct RamaTtrpcProtoBuilder { /* private fields */ }

Available on crate feature ttrpc only.

Builder for configuring and generating ttRPC code from .proto files.

Analogous to rama-grpc-build’s builder.

Implementations

impl RamaTtrpcProtoBuilder

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

Set the output directory for generated code.

Defaults to the Cargo OUT_DIR. A build script that generates code for multiple RPC flavours can point each at its own subdirectory to avoid file-name collisions.

pub fn set_out_dir( &mut self, out_dir: impl AsRef<Path>, ) -> &mut RamaTtrpcProtoBuilder

Set the output directory for generated code.

Defaults to the Cargo OUT_DIR. A build script that generates code for multiple RPC flavours can point each at its own subdirectory to avoid file-name collisions.

pub fn with_extern_path( self, proto_path: impl AsRef<str>, rust_path: impl AsRef<str>, ) -> RamaTtrpcProtoBuilder

Declare an externally provided Protobuf package or type.

Passed directly to prost_build::Config::extern_path. Useful to share generated message types with another codegen (e.g. rama-grpc-build) instead of regenerating them.

pub fn set_extern_path( &mut self, proto_path: impl AsRef<str>, rust_path: impl AsRef<str>, ) -> &mut RamaTtrpcProtoBuilder

Declare an externally provided Protobuf package or type.

Passed directly to prost_build::Config::extern_path. Useful to share generated message types with another codegen (e.g. rama-grpc-build) instead of regenerating them.

pub fn with_protoc_arg(self, arg: impl AsRef<str>) -> RamaTtrpcProtoBuilder

Add an argument to the protoc invocation.

Passed directly to prost_build::Config::protoc_arg.

pub fn set_protoc_arg( &mut self, arg: impl AsRef<str>, ) -> &mut RamaTtrpcProtoBuilder

Add an argument to the protoc invocation.

Passed directly to prost_build::Config::protoc_arg.

pub fn with_skip_protoc_run(self) -> RamaTtrpcProtoBuilder

Skip running protoc and instead use a pre-generated file descriptor set.

Passed directly to prost_build::Config::skip_protoc_run. This requires a file descriptor set to be available, so with_file_descriptor_set_path / set_file_descriptor_set_path must also be set — otherwise codegen fails.

pub fn set_skip_protoc_run(&mut self) -> &mut RamaTtrpcProtoBuilder

Skip running protoc and instead use a pre-generated file descriptor set.

Passed directly to prost_build::Config::skip_protoc_run. This requires a file descriptor set to be available, so with_file_descriptor_set_path / set_file_descriptor_set_path must also be set — otherwise codegen fails.

pub fn with_file_descriptor_set_path( self, path: impl AsRef<Path>, ) -> RamaTtrpcProtoBuilder

Set the path to the protobuf file descriptor set.

Passed directly to prost_build::Config::file_descriptor_set_path. When protoc runs, the descriptor set is written to this path; when with_skip_protoc_run / set_skip_protoc_run is enabled, prost reads a pre-generated descriptor set from it instead of invoking protoc. It must therefore be provided whenever protoc is skipped.

pub fn set_file_descriptor_set_path( &mut self, path: impl AsRef<Path>, ) -> &mut RamaTtrpcProtoBuilder

Set the path to the protobuf file descriptor set.

Passed directly to prost_build::Config::file_descriptor_set_path. When protoc runs, the descriptor set is written to this path; when with_skip_protoc_run / set_skip_protoc_run is enabled, prost reads a pre-generated descriptor set from it instead of invoking protoc. It must therefore be provided whenever protoc is skipped.

pub fn compile_protos<P>( self, protos: &[P], includes: &[P], ) -> Result<(), Error>

where P: AsRef<Path>,

Compile .proto files into ttRPC stubs and execute code generation.

Errors

See compile_protos.

Trait Implementations

impl Clone for RamaTtrpcProtoBuilder

fn clone(&self) -> RamaTtrpcProtoBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RamaTtrpcProtoBuilder

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

Formats the value using the given formatter.

impl Default for RamaTtrpcProtoBuilder

fn default() -> RamaTtrpcProtoBuilder

Returns the “default value” for a type.