Enum RedirectPolicy 

pub enum RedirectPolicy {
    None,
    Follow {
        max_redirects: usize,
    },
}

Redirect behavior for a request.

Variants

None

Do not follow redirects automatically.

Follow

Follow redirects up to max_redirects.

Fields

max_redirects: usize

Maximum number of redirect hops to follow.

Implementations

impl RedirectPolicy

pub const fn none() -> Self

Convenience constructor for RedirectPolicy::None.

pub const fn follow(max_redirects: usize) -> Self

Convenience constructor for RedirectPolicy::Follow.

Examples found in repository

examples/request-builder/main.rs (line 16)

fn main() -> Result<(), Box<dyn Error>> {
    let url = "http://example.com";
    let mut request = Request::get(url)?.with_redirect_policy(RedirectPolicy::follow(5));

    request.add_header("Accept", "text/html,application/xhtml+xml")?;
    request.add_header("Cache-Control", "max-age=0")?;
    request.if_none_match("\"demo-etag\"")?;
    request.if_modified_since(UNIX_EPOCH + Duration::from_secs(784_111_777))?;
    request.range_bytes(Some(0), Some(255))?;

    // Protocol-managed headers such as Host and Connection are intentionally rejected by the
    // library. This example only uses safe end-to-end request headers.
    let response = request.execute()?;

    println!("manual request to {url}");
    println!(
        "status: {} {}",
        response.status_code, response.reason_phrase
    );
    println!("content-type: {:?}", response.header("content-type"));
    println!("body preview: {}", preview_text(response.body_text()?, 80));

    Ok(())
}

pub fn max_redirects(self) -> Option<usize>

Returns the configured redirect limit for RedirectPolicy::Follow, otherwise None.

Trait Implementations

impl Clone for RedirectPolicy

fn clone(&self) -> RedirectPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedirectPolicy

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

Formats the value using the given formatter.

impl PartialEq for RedirectPolicy

fn eq(&self, other: &RedirectPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RedirectPolicy

impl Eq for RedirectPolicy

impl StructuralPartialEq for RedirectPolicy