wreq 0.16.1

An ergonomic, privacy-aware Rust HTTP Client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

use std::{
    future::Future,
    pin::Pin,
    task::{Context, Poll, ready},
    time::Duration,
};

use http::Response;
use pin_project_lite::pin_project;
use wreq_proto::rt::Sleep;

use super::body::TimeoutBody;
use crate::{
    error::{BoxError, Error, TimedOut},
    rt::Timer,
};

pin_project! {
    /// Waits for response headers, then moves the total timeout into the response body.
    pub struct ResponseFuture<Fut> {
        #[pin]
        pub(super) fut: Fut,
        pub(super) timer: Timer,
        pub(super) read_timeout: Option<Duration>,
        pub(super) read_timeout_fut: Option<Pin<Box<dyn Sleep>>>,
        pub(super) total_timeout_fut: Option<Pin<Box<dyn Sleep>>>,
    }
}

impl<Fut, ResBody, E> Future for ResponseFuture<Fut>
where
    Fut: Future<Output = Result<Response<ResBody>, E>>,
    E: Into<BoxError>,
{
    type Output = Result<Response<TimeoutBody<ResBody>>, BoxError>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
        let this = self.project();

        // The total timer covers response headers and body. Poll it first so an
        // expired timeout wins, then move it into `TimeoutBody` below.
        if let Some(timeout) = this.total_timeout_fut.as_mut()
            && timeout.as_mut().poll(cx).is_ready()
        {
            return Poll::Ready(Err(Error::request(TimedOut).into()));
        }

        // Before headers arrive, the read timer limits that wait. The body starts
        // and resets its own read timer after each successful frame.
        if let Some(timeout) = this.read_timeout_fut.as_mut()
            && timeout.as_mut().poll(cx).is_ready()
        {
            return Poll::Ready(Err(Error::request(TimedOut).into()));
        }

        // Poll the request after both timers so every pending future registers the
        // current waker before `ready!` returns.
        let response = ready!(this.fut.poll(cx)).map_err(Into::into)?;

        // Moving the running total timer preserves the original deadline.
        Poll::Ready(Ok(response.map(|body| {
            TimeoutBody::new(
                body,
                this.timer.clone(),
                *this.read_timeout,
                this.total_timeout_fut.take(),
            )
        })))
    }
}