Skip to main content

Redirect

Struct Redirect 

Source
pub struct Redirect { /* private fields */ }
Expand description

HTTP redirect response.

Implementations§

Source§

impl Redirect

Source

pub fn to(uri: impl Into<String>) -> Result<Self, RedirectError>

302 Found redirect.

§Safe-by-default validation (br-asupersync-0hj233)

Returns Err(RedirectError) for any URI that is not a site-relative path (/foo). Specifically rejects:

  • empty strings,
  • protocol-relative URIs (//attacker.com/...),
  • URIs containing backslash (/\\attacker.com/...),
  • any URI with a scheme (javascript:, https://attacker.com/, …).

For redirects that legitimately point at an external host (OAuth callbacks, payment hand-offs), use Self::to_with_allowed_hosts (validated against an allowlist) or Self::external_unchecked (caller asserts the URI is trustworthy).

Source

pub fn permanent(uri: impl Into<String>) -> Result<Self, RedirectError>

301 Moved Permanently redirect. Same safe-by-default validation as Self::to; see that method for details.

Source

pub fn temporary(uri: impl Into<String>) -> Result<Self, RedirectError>

307 Temporary Redirect (preserves method). Same safe-by-default validation as Self::to; see that method for details.

Source

pub fn to_with_allowed_hosts( uri: impl Into<String>, allowed_hosts: &[&str], ) -> Result<Self, RedirectError>

302 Found redirect with an explicit allowed-hosts allowlist (br-asupersync-0hj233).

Accepts site-relative paths AND absolute http(s) URIs whose host appears (case-insensitive) in allowed_hosts. Use this for redirect flows whose target host space is statically-known (OAuth providers, payment gateways).

Source

pub fn external_unchecked(uri: impl Into<String>) -> Self

Unchecked 302 Found redirect — caller asserts the URI is trustworthy (br-asupersync-0hj233).

This bypasses the open-redirect validation in Self::to. Use ONLY when the URI is genuinely controlled by the application (a hard-coded constant, a value derived from trusted server-side state, or an OAuth provider URL whose host is independently verified). NEVER pass user-supplied strings (URL parameters, form fields, request body) to this constructor — that’s the canonical phishing vector this bead is defending against.

The CRLF stripping in the wire-format step (see into_response) still applies — this only bypasses the scheme/host validation.

Source

pub fn external_unchecked_permanent(uri: impl Into<String>) -> Self

Unchecked 301 Moved Permanently redirect; see Self::external_unchecked for the safety contract.

Source

pub fn external_unchecked_temporary(uri: impl Into<String>) -> Self

Unchecked 307 Temporary Redirect; see Self::external_unchecked for the safety contract.

Trait Implementations§

Source§

impl Clone for Redirect

Source§

fn clone(&self) -> Redirect

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Redirect

Source§

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

Formats the value using the given formatter. Read more
Source§

impl IntoResponse for Redirect

Source§

fn into_response(self) -> Response

Convert self into a Response.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more