Struct Redirect

pub struct Redirect { /* private fields */ }

Utility struct to easily create a redirect response.

Implementations

impl Redirect

pub fn to(loc: impl IntoRedirectLoc) -> Redirect

Create a new Redirect that uses a 303 See Other status code.

This redirect instructs the client to change the method to GET for the subsequent request to the given location, which is useful after successful form submission, file upload or when you generally don’t want the redirected-to page to observe the original request method and body (if non-empty). If you want to preserve the request method and body, Redirect::temporary should be used instead.

pub fn moved(loc: impl IntoRedirectLoc) -> Redirect

Create a new found (301) redirect response.

Used if a resource is permanently moved.

Use Self::permanent in case you wish to respect the original HTTP Method.

pub fn found(loc: impl IntoRedirectLoc) -> Redirect

Create a new found (302) redirect response.

Can be useful in flows where the resource was legit and found, but a pre-requirement such as authentication wasn’t met.

pub fn temporary(loc: impl IntoRedirectLoc) -> Redirect

Create a new temporary (307) redirect response.

pub fn permanent(loc: impl IntoRedirectLoc) -> Redirect

Create a new permanent (308) redirect response.

pub fn status_code(&self) -> StatusCode

Returns the HTTP status code of the Redirect.

pub fn location(&self) -> &HeaderValue

Returns the Redirect’s URI

pub fn location_str(&self) -> Cow<'_, str>

Returns the Redirect’s URI as a lossy-utf-8 str

Trait Implementations

impl Clone for Redirect

fn clone(&self) -> Redirect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Redirect

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

Formats the value using the given formatter.

impl IntoResponse for Redirect

fn into_response(self) -> Response

Create a response.