Struct reqwest::RedirectPolicy

source · [−]

pub struct RedirectPolicy { /* private fields */ }

Expand description

A type that controls the policy on how to handle the following of redirects.

The default value will catch redirect loops, and has a maximum of 10 redirects it will follow in a chain before returning an error.

limited can be used have the same as the default behavior, but adjust the allowed maximum redirect hops in a chain.
none can be used to disable all redirect behavior.
custom can be used to create a customized policy.

Implementations

source

impl RedirectPolicy

source

pub fn limited(max: usize) -> RedirectPolicy

Create a RedirectPolicy with a maximum number of redirects.

An Error will be returned if the max is reached.

source

pub fn none() -> RedirectPolicy

Create a RedirectPolicy that does not follow any redirect.

source

pub fn custom<T>(policy: T) -> RedirectPolicy where
T: Fn(RedirectAttempt<'_>) -> RedirectAction + Send + Sync + 'static,

Create a custom RedirectPolicy using the passed function.

Note

The default RedirectPolicy handles redirect loops and 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 RedirectAttempt argument passed to the closure.

Actions can be conveniently created from methods on the RedirectAttempt.

Example

let custom = RedirectPolicy::custom(|attempt| {
    if attempt.previous().len() > 5 {
        attempt.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()?;

source

pub fn redirect(&self, attempt: RedirectAttempt<'_>) -> RedirectAction

Apply this policy to a given RedirectAttempt to produce a RedirectAction.

Note

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

Example

let custom = RedirectPolicy::custom(|attempt| {
    eprintln!("{}, Location: {:?}", attempt.status(), attempt.url());
    RedirectPolicy::default().redirect(attempt)
});