Struct SslRedirectLayer 

pub struct SslRedirectLayer { /* private fields */ }

Redirect settings. Apply them with SslRedirectRouterExt::ssl_redirect.

Implementations

impl SslRedirectLayer

pub fn new() -> Self

No proxy header, nothing exempt. Behind a TLS-terminating proxy, add Self::proxy_ssl_header or you get a redirect loop.

pub fn proxy_ssl_header( self, header: impl AsRef<str>, value: impl AsRef<str>, ) -> Self

Declare the header your proxy sets when the original request used HTTPS. A matching value skips the redirect.

The layer trusts this header, so the proxy must strip any copy the client sends.

SslRedirectLayer::new().proxy_ssl_header("X-Forwarded-Proto", "https")

An invalid header name or value is ignored, as if you never called this method.

pub fn exempt<I, S>(self, paths: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add path prefixes that skip the redirect, such as health checks reached over plain HTTP.

pub fn is_secure(&self, req: &Request<Body>) -> bool

true when the request already arrived over HTTPS, so no redirect is needed.

pub fn is_exempt(&self, path: &str) -> bool

true when the request path matches any exempt prefix.

Trait Implementations

impl Clone for SslRedirectLayer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SslRedirectLayer

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

Formats the value using the given formatter.

impl Default for SslRedirectLayer

fn default() -> Self

Returns the “default value” for a type.