Struct axum::response::Redirect

pub struct Redirect { /* private fields */ }

Response that redirects the request to another location.

Example

use axum::{
    routing::get,
    response::Redirect,
    Router,
};

let app = Router::new()
    .route("/old", get(|| async { Redirect::permanent("/new".parse().unwrap()) }))
    .route("/new", get(|| async { "Hello!" }));

Implementations

impl Redirect

pub fn to(uri: Uri) -> Self

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 uri, 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.

Panics

If uri isn’t a valid HeaderValue.

pub fn temporary(uri: Uri) -> Self

Create a new Redirect that uses a 307 Temporary Redirect status code.

This has the same behavior as Redirect::to, except it will preserve the original HTTP method and body.

Panics

If uri isn’t a valid HeaderValue.

pub fn permanent(uri: Uri) -> Self

Create a new Redirect that uses a 308 Permanent Redirect status code.

Panics

If uri isn’t a valid HeaderValue.

pub fn found(uri: Uri) -> Self

👎 Deprecated:

This results in different behavior between clients, so Redirect::temporary or Redirect::to should be used instead

Create a new Redirect that uses a 302 Found status code.

This is the same as Redirect::temporary (307 Temporary Redirect) except this status code is older and thus supported by some legacy clients that don’t understand the newer one. Many clients wrongly apply Redirect::to (303 See Other) semantics for this status code, so it should be avoided where possible.

Panics

If uri isn’t a valid HeaderValue.

Trait Implementations

impl Clone for Redirect

fn clone(&self) -> Redirect

Returns a copy 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

Formats the value using the given formatter.

impl IntoResponse for Redirect

fn into_response(self) -> Response

Create a response.