Struct Redirect

pub struct Redirect(/* private fields */);

An empty redirect response to a given URL.

This type simplifies returning a redirect response to the client.

Usage

All constructors accept a generic type of T: TryInto<Reference<'static>>. Among the candidate types are:

• String, &'static str
• Origin
• Authority
• Absolute
• Reference

Any non-'static strings must first be allocated using .to_string() or similar before being passed to a Redirect constructor. When redirecting to a route, or any URI containing a route, always use uri! to construct a valid URI:

use rocket::response::Redirect;

#[get("/hello/<name>/<age>")]
fn hello(name: String, age: u8) -> String {
    format!("Hello, {} year old named {}!", age, name)
}

#[get("/hi/<name>/<age>")]
fn hi(name: String, age: u8) -> Redirect {
    Redirect::to(uri!(hello(name, age)))
}

#[get("/bye/<name>/<age>")]
fn bye(name: String, age: u8) -> Redirect {
    Redirect::to(uri!("https://rocket.rs/bye", hello(name, age), "?bye#now"))
}

Implementations

impl Redirect

pub fn to<U: TryInto<Reference<'static>>>(uri: U) -> Redirect

Construct a temporary “see other” (303) redirect response. This is the typical response when redirecting a user to another page. This type of redirect indicates that the client should look elsewhere, but always via a GET request, for a given resource.

Examples

use rocket::response::Redirect;

let redirect = Redirect::to(uri!("/foo/bar"));
let redirect = Redirect::to(uri!("https://domain.com#foo"));

pub fn temporary<U: TryInto<Reference<'static>>>(uri: U) -> Redirect

Construct a “temporary” (307) redirect response. This response instructs the client to reissue the current request to a different URL, maintaining the contents of the request identically. This means that, for example, a POST request will be resent, contents included, to the requested URL.

Examples

use rocket::response::Redirect;

let redirect = Redirect::temporary(uri!("some/other/path"));
let redirect = Redirect::temporary(uri!("https://rocket.rs?foo"));
let redirect = Redirect::temporary(format!("some-{}-thing", "crazy"));

pub fn permanent<U: TryInto<Reference<'static>>>(uri: U) -> Redirect

Construct a “permanent” (308) redirect response. This redirect must only be used for permanent redirects as it is cached by clients. This response instructs the client to reissue requests for the current URL to a different URL, now and in the future, maintaining the contents of the request identically. This means that, for example, a POST request will be resent, contents included, to the requested URL.

Examples

use rocket::response::Redirect;

let redirect = Redirect::permanent(uri!("/other_url"));
let redirect = Redirect::permanent(format!("some-{}-thing", "crazy"));

pub fn found<U: TryInto<Reference<'static>>>(uri: U) -> Redirect

Construct a temporary “found” (302) redirect response. This response instructs the client to reissue the current request to a different URL, ideally maintaining the contents of the request identically. Unfortunately, different clients may respond differently to this type of redirect, so 303 or 307 redirects, which disambiguate, are preferred.

Examples

use rocket::response::Redirect;

let redirect = Redirect::found(uri!("/other_url"));
let redirect = Redirect::found(format!("some-{}-thing", "crazy"));

pub fn moved<U: TryInto<Reference<'static>>>(uri: U) -> Redirect

Construct a permanent “moved” (301) redirect response. This response should only be used for permanent redirects as it can be cached by browsers. Because different clients may respond differently to this type of redirect, a 308 redirect, which disambiguates, is preferred.

Examples

use rocket::response::Redirect;

let redirect = Redirect::moved(uri!("here"));
let redirect = Redirect::moved(format!("some-{}-thing", "crazy"));

pub fn map_uri<U: TryInto<Reference<'static>>>( self, f: impl FnOnce(Reference<'static>) -> U, ) -> Redirect

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<'r> From<Redirect> for Rewrite<'r>

fn from(value: Redirect) -> Self

Converts to this type from the input type.

impl<'r> Responder<'r, 'static> for Redirect

Constructs a response with the appropriate status code and the given URL in the Location header field. The body of the response is empty. If the URI value used to create the Responder is an invalid URI, an error of Status::InternalServerError is returned.

fn respond_to(self, _: &'r Request<'_>) -> Result<'static>

Returns Ok if a Response could be generated successfully. Otherwise, returns an Err with a failing Status.

impl Rewriter for Redirect

fn rewrite<'r>( &self, _: Option<Rewrite<'r>>, _: &Request<'_>, ) -> Option<Rewrite<'r>>

Alter the Rewrite as needed.