Struct actix_web_lab::web::Redirect

pub struct Redirect { /* private fields */ }

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

Redirects are either relative or absolute.

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

Examples

use actix_web::{web, App};
use actix_web_lab::web as web_lab;

App::new()
    // redirect "/duck" to DuckDuckGo
    .service(web_lab::Redirect::new("/duck", "https://duckduckgo.com/"))
    .service(
        // redirect "/api/old" to "/api/new" using `web::redirect` helper
        web::scope("/api").service(web_lab::redirect("/old", "/new"))
    );

Implementations

impl Redirect

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

Create a new Redirect service, first providing the path that should be redirected.

The default “to” location is the root path (/). It is expected that you should call either to or to afterwards.

Note this function has no effect when used as a responder.

Redirect to an address or path.

Whatever argument is provided shall be used as-is when setting the redirect location. You can also use relative paths to navigate relative to the matched path.

Examples

// redirects "/oh/hi/mark" to "/oh/bye/mark"
Redirect::new("/oh/hi/mark", "../../bye/mark");

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

Shortcut for creating a redirect to use as a Responder.

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

pub fn temporary(self) -> Self

Use the “307 Temporary Redirect” status when responding.

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

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

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 HttpServiceFactory for Redirect

fn register(self, config: &mut AppService)

impl Responder for Redirect

type Body = BoxBody

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

Convert self to HttpResponse.

fn customize(self) -> CustomizeResponder<Self>

Wraps responder to allow alteration of its response.