Struct TwirpBuilder

pub struct TwirpBuilder { /* private fields */ }

Builds protobuf bindings for Twirp.

Client and server are not enabled by defaults and must be enabled with the with_client and with_server methods.

Implementations

impl TwirpBuilder

pub fn new() -> Self

Builder with the default prost Config.

pub fn from_prost(config: Config) -> Self

Builder with a custom prost Config.

pub fn with_client(self) -> Self

Generates code for the Twirp client.

pub fn with_server(self) -> Self

Generates code for the Twirp server.

pub fn with_grpc(self) -> Self

Generates code for gRPC alongside Twirp.

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

Adds an extra parameter to generated server methods that implements axum::FromRequestParts.

For example

message Service {
    rpc Test(TestRequest) returns (TestResponse) {}
}

Compiled with option .with_axum_request_extractor("headers", "::axum::http::HeaderMap") will generate the following code allowing to extract the request headers:

trait Service {
    async fn test(request: TestRequest, headers: ::axum::http::HeaderMap) -> Result<TestResponse, TwirpError>;
}

Note that the parameter type must implement axum::FromRequestParts.

pub fn with_type_name_domain(self, domain: impl Into<String>) -> Self

Customizes the type name domain.

By default, ‘type.googleapis.com’ is used.

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

Do compile the protos.

Trait Implementations

impl Default for TwirpBuilder

fn default() -> TwirpBuilder

Returns the “default value” for a type.