Struct surf::middleware::Redirect

pub struct Redirect { /* fields omitted */ }

A middleware which attempts to follow HTTP redirects.

Implementations

impl Redirect

pub fn new(attempts: u8) -> Self

Create a new instance of the Redirect middleware, which attempts to follow redirects up to as many times as specified.

Consider using Redirect::default() for the default number of redirect attempts.

This middleware will follow redirects from the Location header if the server returns any of the following http response codes:

• 301 Moved Permanently
• 302 Found
• 303 See other
• 307 Temporary Redirect
• 308 Permanent Redirect

Errors

An error will be passed through the middleware stack if the value of the Location header is not a validly parsing url.

Caveats

This will presently make at least one additional HTTP request before the actual request to determine if there is a redirect that should be followed, so as to preserve any request body.

Examples

let req = surf::get("https://httpbin.org/redirect/2");
let client = surf::client().with(surf::middleware::Redirect::new(5));
let mut res = client.send(req).await?;
dbg!(res.body_string().await?);

Trait Implementations

impl Debug for Redirect

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

Formats the value using the given formatter.

impl Default for Redirect

fn default() -> Self

Create a new instance of the Redirect middleware, which attempts to follow up to 3 redirects (not including the actual request).

impl Middleware for Redirect

fn handle<'life0, 'life1, 'async_trait>(
    &'life0 self,
    req: Request,
    client: Client,
    next: Next<'life1>
) -> Pin<Box<dyn Future<Output = Result<Response>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Asynchronously handle the request, and return a response.