Struct RewriteLayer 

pub struct RewriteLayer { /* private fields */ }

Composable request/response rewriting middleware.

Clones the incoming Request, applies request rules, dispatches to the next handler, then applies response rules on the returned Response.

All builder methods take self by value and return Self for chaining.

Implementations

impl RewriteLayer

pub fn new() -> RewriteLayer

pub fn request_header_set(self, name: &str, value: &str) -> RewriteLayer

Add or replace a request header (case-insensitive name match).

pub fn request_header_remove(self, name: &str) -> RewriteLayer

Remove a request header (case-insensitive).

pub fn request_uri_set(self, uri: &str) -> RewriteLayer

Replace the entire request URI.

pub fn request_uri_strip_prefix(self, prefix: &str) -> RewriteLayer

Strip a path prefix from the request URI. No-op if the prefix is absent. Normalizes to "/" if stripping leaves an empty path.

pub fn request_uri_add_prefix(self, prefix: &str) -> RewriteLayer

Prepend a prefix to the request URI.

pub fn request_uri_regex_rewrite( self, pattern: &str, replacement: &str, ) -> Result<RewriteLayer, Error>

Available on crate feature rewrite-regex only.

Rewrite the request URI by regex, nginx rewrite-directive style.

If pattern matches anywhere in the URI, the entire URI is replaced by replacement with capture-group references expanded — $1, $2, … for numbered groups, ${name} for named groups ((?P<name>...)), or $0/${0} for the whole match. If pattern does not match, the URI is left unchanged.

Returns Err if pattern is not a valid regex. Requires the rewrite-regex feature.

pub fn response_header_set(self, name: &str, value: &str) -> RewriteLayer

Add or replace a response header (case-insensitive name match).

pub fn response_header_remove(self, name: &str) -> RewriteLayer

Remove a response header (case-insensitive).

pub fn response_status(self, code: i16, reason: &str) -> RewriteLayer

Override the response status code and reason phrase.

pub fn response_body_replace(self, from: &str, to: &str) -> RewriteLayer

Byte-level find-and-replace across all response body content ranges.

Trait Implementations

impl Middleware for RewriteLayer

fn handle( &self, request: &Request, connection: &ConnectionInfo, next: &dyn Application, ) -> Result<Response, String>

fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool

true when this layer’s own work for request never blocks (in-memory state, atomics, short mutexes) — see Application::runs_inline. A WithMiddleware stack runs inline only if every layer and the inner application agree. Default false.

fn is_passthrough( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when handle would do nothing for request but call next (e.g. a rate limit that isn’t configured). A WithMiddleware stack offers the inner application’s execute_async only if every layer passes the request through. Default false.

fn accepts_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer never reads request.body, so the inner application may receive it as a stream (Application::streams_body). A layer that inspects the body (CSRF tokens in a form, request signatures, rewriting) must keep the default false: it would see an empty body.

fn answers_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer answers request itself — it doesn’t call next — and reads its body as a stream (a proxy forwarding it as it arrives). The body is then streamed whatever the layers after it and the application would say. Requires accepts_streamed_body. Since 18.3.0.

fn layer_name(&self) -> &'static str

A short name for this layer, as tools that describe an app list it (Application::middleware_names): by default the type’s name without its module path or generic parameters (CacheLayer). Since 18.28.0.