Struct Gateway 

pub struct Gateway<S> { /* private fields */ }

A builder and configuration struct for the Gateway runtime.

Wraps a Router and allows attaching various handlers and configuration options. The into_service() method consumes this builder to produce the final Service.

Implementations

impl<S> Gateway<S>

pub fn new(router: Router<S>) -> Self

Creates a new Gateway wrapping the given Router and initialized with secure defaults.

pub fn with_error_handler<F>(self, handler: F) -> Self

where F: Fn(&GatewayRequest, GatewayError) -> GatewayResponse + Send + Sync + 'static,

Sets the custom error handler.

pub fn with_metadata<F>(self, annotator: F) -> Self

where F: Fn(&GatewayRequest) -> MetadataMap + Send + Sync + 'static,

Adds a metadata annotator.

pub fn with_response_modifier<F>(self, modifier: F) -> Self

where F: Fn(&GatewayRequest, &mut GatewayResponse) + Send + Sync + 'static,

Adds a response modifier.

pub fn with_incoming_header_matcher<F>(self, matcher: F) -> Self

where F: Fn(&str) -> Option<String> + Send + Sync + 'static,

Sets the incoming header matcher.

pub fn with_outgoing_header_matcher<F>(self, matcher: F) -> Self

where F: Fn(&str) -> Option<String> + Send + Sync + 'static,

Sets the outgoing header matcher.

pub fn with_unescaping_mode(self, mode: UnescapingMode) -> Self

Sets the unescaping mode.

pub fn with_auth_verifier<F>(self, verifier: F) -> Self

where F: Fn(&GatewayRequest, &RouteMetadata) -> Result<(), GatewayError> + Send + Sync + 'static,

Sets the authentication verifier.

pub fn with_metrics_recorder<F>(self, recorder: F) -> Self

where F: Fn(&GatewayRequest, &GatewayResult, Duration) + Send + Sync + 'static,

Sets the metrics recorder.

pub fn with_tracing<Start, End>(self, start: Start, end: End) -> Self

where Start: Fn(&GatewayRequest) -> Box<dyn Any + Send> + Send + Sync + 'static, End: Fn(Box<dyn Any + Send>, &GatewayResult) + Send + Sync + 'static,

Sets tracing handlers.

pub fn with_metadata_config(self, config: MetadataForwardingConfig) -> Self

Sets the metadata forwarding configuration.

pub fn metadata_config(&self) -> &MetadataForwardingConfig

Returns a reference to the metadata configuration.

impl<S> Gateway<S>

where S: Service<GatewayRequest, Response = GatewayResponse, Error = GatewayError> + Clone + Send + 'static, S::Future: Send + 'static,

pub fn into_service( self, ) -> BoxCloneService<GatewayRequest, GatewayResponse, GatewayError>

Consumes the Gateway configuration and returns a constructed tower::BoxCloneService.

This method assembles the complete middleware stack around the router.