Struct rocket::response::Redirect

source ·
pub struct Redirect(/* private fields */);
Expand description

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<Uri<'static>>. Among the candidate types are:

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, always use uri! to construct a valid Origin:

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))
}

Implementations§

source§

impl Redirect

source

pub fn to<U: TryInto<Uri<'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("/other_url");
let redirect = Redirect::to(format!("https://google.com/{}", query));
source

pub fn temporary<U: TryInto<Uri<'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("/other_url");
let redirect = Redirect::temporary(format!("https://google.com/{}", query));
source

pub fn permanent<U: TryInto<Uri<'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("/other_url");
let redirect = Redirect::permanent(format!("https://google.com/{}", query));
source

pub fn found<U: TryInto<Uri<'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("/other_url");
let redirect = Redirect::found(format!("https://google.com/{}", query));
source

pub fn moved<U: TryInto<Uri<'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("/other_url");
let redirect = Redirect::moved(format!("https://google.com/{}", query));

Trait Implementations§

source§

impl Debug for Redirect

source§

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

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

impl<'a> Responder<'a> 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.

source§

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

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

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, I> AsResult<T, I> for T
where I: Input,

source§

fn as_result(self) -> Result<T, ParseErr<I>>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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.

§

impl<T> IntoCollection<T> for T

§

fn into_collection<A>(self) -> SmallVec<A>
where A: Array<Item = T>,

Converts self into a collection.
§

fn mapped<U, F, A>(self, f: F) -> SmallVec<A>
where F: FnMut(T) -> U, A: Array<Item = U>,

source§

impl<T> Same for T

source§

type Output = T

Should always be Self
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<T> Typeable for T
where T: Any,

source§

fn get_type(&self) -> TypeId

Get the TypeId of this object.
source§

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

source§

fn vzip(self) -> V