Struct RedirectPlugin 

pub struct RedirectPlugin {
    http_to_https: bool,
    uri_tpl: Option<Template>,
    ret_code: u16,
    append_query_string: bool,
}

Builds a redirect response from either a uri template (with {{namespace.path}} references plus legacy $var interpolation) or the http_to_https shortcut.

This plugin never fails at execution time. A prepared redirect exits on the dedicated redirect port. The only case where it does not redirect is http_to_https on a request that is already HTTPS (per x-forwarded-proto or the request scheme): the context passes through unchanged on success, so http_to_https should only be wired into routes served over plain HTTP.

Fields

http_to_https: bool

Redirect plain-HTTP requests to https://$host$request_uri.

uri_tpl: Option<Template>

Redirect target template; supports {{namespace.path}} references and legacy $var / ${var} interpolation (see Template::render_with_legacy).

ret_code: u16

Status code for uri redirects (http_to_https picks 301/308 itself).

append_query_string: bool

Append the original query string to the target.

Implementations

impl RedirectPlugin

pub fn from_config(config: &HashMap<String, Value>) -> Result<Self, String>

Builds the plugin from node config.

Accepted keys — exactly one of uri / http_to_https: true is required:

• uri (string): redirect target template. Supports {{namespace.path}} references (e.g. {{request.host}}) plus legacy $var / ${var} interpolation against the context (see crate::vars::template::Template::render_with_legacy), e.g. /new$request_uri or https://$host/login. Unknown legacy variables resolve to "".
• http_to_https (bool): redirect HTTP requests to https://$host$request_uri with 301 for GET/HEAD and 308 otherwise (so the method and body survive). Already-HTTPS requests pass through unchanged.
• ret_code (integer, default 302, minimum 200): status code for uri redirects.
• append_query_string (bool, default false): append the original query string to the target (? or & as appropriate). Cannot be combined with http_to_https, which already keeps the query string via $request_uri.

type: redirect
config:
  uri: https://$host/new-prefix$uri
  ret_code: 301
  append_query_string: true

Trait Implementations

impl Plugin for RedirectPlugin

fn plugin_type(&self) -> &str

Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”). This is also the key its PortSpec is registered under in port_spec.

fn execute<'life0, 'async_trait>( &'life0 self, ctx: Context, ) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes the plugin logic against the request/response context.

fn reads_response_body(&self) -> bool

Whether this configured instance reads context.response.body.

fn cache_target(&self) -> Option<CacheTarget>

The cache backend this node writes to, if it is a proxy-cache half.