impl Policy

fn limited(max: usize) -> Self

Create a Policy with a maximum number of redirects.

An Error will be returned if the max is reached.

fn none() -> Self

Create a Policy that does not follow any redirect.

fn custom<T>(policy: T) -> Self
where
    T: Fn(Attempt<'_>) -> Action + Send + Sync + 'static,

Create a custom Policy using the passed function.

Note

The default Policy handles a maximum loop chain, but the custom variant does not do that for you automatically. The custom policy should have some way of handling those.

Information on the next request and previous requests can be found on the Attempt argument passed to the closure.

Actions can be conveniently created from methods on the Attempt.

Example

# use reqwest::{Error, redirect};
#
# fn run() -> Result<(), Error> {
let custom = redirect::Policy::custom(|attempt| {
    if attempt.previous().len() > 5 {
        attempt.error("too many redirects")
    } else if attempt.url().host_str() == Some("example.domain") {
        // prevent redirects to 'example.domain'
        attempt.stop()
    } else {
        attempt.follow()
    }
});
let client = reqwest::Client::builder()
    .redirect(custom)
    .build()?;
# Ok(())
# }

fn redirect(&self, attempt: Attempt<'_>) -> Action

Apply this policy to a given Attempt to produce a Action.

Note

This method can be used together with Policy::custom() to construct one Policy that wraps another.

Example

# use reqwest::{Error, redirect};
#
# fn run() -> Result<(), Error> {
let custom = redirect::Policy::custom(|attempt| {
    eprintln!("{}, Location: {:?}", attempt.status(), attempt.url());
    redirect::Policy::default().redirect(attempt)
});
# Ok(())
# }