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<Reference<'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, 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§
source§impl Redirect
impl Redirect
sourcepub fn to<U: TryInto<Reference<'static>>>(uri: U) -> 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"));
sourcepub fn temporary<U: TryInto<Reference<'static>>>(uri: U) -> Redirect
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"));
sourcepub fn permanent<U: TryInto<Reference<'static>>>(uri: U) -> Redirect
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"));
sourcepub fn found<U: TryInto<Reference<'static>>>(uri: U) -> Redirect
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"));
sourcepub fn moved<U: TryInto<Reference<'static>>>(uri: U) -> Redirect
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"));
Trait Implementations§
source§impl<'r> Responder<'r, 'static> for Redirect
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.
Auto Trait Implementations§
impl !RefUnwindSafe for Redirect
impl Send for Redirect
impl Sync for Redirect
impl Unpin for Redirect
impl UnwindSafe for Redirect
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere T: ?Sized,
source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
Example
println!("{}", value.bright_yellow());
source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
Example
println!("{}", value.bright_magenta());
source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
Example
println!("{}", value.on_bright_black());
source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
Example
println!("{}", value.on_bright_white());
source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
Example
println!("{}", value.rapid_blink());
source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);