Struct actix_web::web::Redirect

source ·
pub struct Redirect { /* private fields */ }
Expand description

An HTTP service for redirecting one path to another path or URL.

By default, the “307 Temporary Redirect” status is used when responding. See this MDN article on why 307 is preferred over 302.

§Examples

As service:

use actix_web::{web, App};

App::new()
    // redirect "/duck" to DuckDuckGo
    .service(web::redirect("/duck", "https://duck.com"))
    .service(
        // redirect "/api/old" to "/api/new"
        web::scope("/api").service(web::redirect("/old", "/new"))
    );

As responder:

use actix_web::{web::Redirect, Responder};

async fn handler() -> impl Responder {
    // sends a permanent (308) redirect to duck.com
    Redirect::to("https://duck.com").permanent()
}

Implementations§

source§

impl Redirect

source

pub fn new( from: impl Into<Cow<'static, str>>, to: impl Into<Cow<'static, str>>, ) -> Self

Construct a new Redirect service that matches a path.

This service will match exact paths equal to from within the current scope. I.e., when registered on the root App, it will match exact, whole paths. But when registered on a Scope, it will match paths under that scope, ignoring the defined scope prefix, just like a normal Resource or Route.

The to argument can be path or URL; whatever is provided shall be used verbatim when setting the redirect location. This means that relative paths can be used to navigate relatively to matched paths.

Prefer Redirect::to() when using Redirect as a responder since from has no meaning in that context.

§Examples
App::new()
    // redirects "/oh/hi/mark" to "/oh/bye/johnny"
    .service(Redirect::new("/oh/hi/mark", "../../bye/johnny"));
source

pub fn to(to: impl Into<Cow<'static, str>>) -> Self

Construct a new Redirect to use as a responder.

Only receives the to argument since responders do not need to do route matching.

§Examples
use actix_web::{web::Redirect, Responder};

async fn admin_page() -> impl Responder {
    // sends a temporary 307 redirect to the login path
    Redirect::to("/login")
}
source

pub fn permanent(self) -> Self

Use the “308 Permanent Redirect” status when responding.

See this MDN article on why 308 is preferred over 301.

source

pub fn temporary(self) -> Self

Use the “307 Temporary Redirect” status when responding.

See this MDN article on why 307 is preferred over 302.

source

pub fn see_other(self) -> Self

Use the “303 See Other” status when responding.

This status code is semantically correct as the response to a successful login, for example.

source

pub fn using_status_code(self, status: StatusCode) -> Self

Allows the use of custom status codes for less common redirect types.

In most cases, the default status (“308 Permanent Redirect”) or using the temporary method, which uses the “307 Temporary Redirect” status have more consistent behavior than 301 and 302 codes, respectively.

// redirects would use "301 Moved Permanently" status code
Redirect::new("/old", "/new")
    .using_status_code(StatusCode::MOVED_PERMANENTLY);

// redirects would use "302 Found" status code
Redirect::new("/old", "/new")
    .using_status_code(StatusCode::FOUND);

Trait Implementations§

source§

impl Clone for Redirect

source§

fn clone(&self) -> Redirect

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Redirect

source§

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

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

impl HttpServiceFactory for Redirect

source§

fn register(self, config: &mut AppService)

source§

impl Responder for Redirect

§

type Body = ()

source§

fn respond_to(self, _req: &HttpRequest) -> HttpResponse<Self::Body>

Convert self to HttpResponse.
source§

fn customize(self) -> CustomizeResponder<Self>
where Self: Sized,

Wraps responder to allow alteration of its response. 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> 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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more