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 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
//! Extension traits for the standard `Stream` and `Future` traits.
use std::io;
use std::pin::Pin;
use std::task::{Context, Poll};
use std::time::Duration;
use futures::prelude::*;
use pin_utils::unsafe_pinned;
use crate::{Delay, Instant};
/// An extension trait for futures which provides convenient accessors for
/// timing out execution and such.
pub trait TryFutureExt: TryFuture + Sized {
/// Creates a new future which will take at most `dur` time to resolve from
/// the point at which this method is called.
///
/// This combinator creates a new future which wraps the receiving future
/// in a timeout. The future returned will resolve in at most `dur` time
/// specified (relative to when this function is called).
///
/// If the future completes before `dur` elapses then the future will
/// resolve with that item. Otherwise the future will resolve to an error
/// once `dur` has elapsed.
///
/// # Examples
///
/// ```no_run
/// use std::time::Duration;
/// use futures::prelude::*;
/// use wasm_timer::TryFutureExt;
///
/// # fn long_future() -> impl TryFuture<Ok = (), Error = std::io::Error> {
/// # futures::future::ok(())
/// # }
/// #
/// fn main() {
/// let future = long_future();
/// let timed_out = future.timeout(Duration::from_secs(1));
///
/// async_std::task::block_on(async {
/// match timed_out.await {
/// Ok(item) => println!("got {:?} within enough time!", item),
/// Err(_) => println!("took too long to produce the item"),
/// }
/// })
/// }
/// ```
fn timeout(self, dur: Duration) -> Timeout<Self>
where
Self::Error: From<io::Error>,
{
Timeout {
timeout: Delay::new(dur),
future: self,
}
}
/// Creates a new future which will resolve no later than `at` specified.
///
/// This method is otherwise equivalent to the `timeout` method except that
/// it tweaks the moment at when the timeout elapsed to being specified with
/// an absolute value rather than a relative one. For more documentation see
/// the `timeout` method.
fn timeout_at(self, at: Instant) -> Timeout<Self>
where
Self::Error: From<io::Error>,
{
Timeout {
timeout: Delay::new_at(at),
future: self,
}
}
}
impl<F: TryFuture> TryFutureExt for F {}
/// Future returned by the `FutureExt::timeout` method.
#[derive(Debug)]
pub struct Timeout<F>
where
F: TryFuture,
F::Error: From<io::Error>,
{
future: F,
timeout: Delay,
}
impl<F> Timeout<F>
where
F: TryFuture,
F::Error: From<io::Error>,
{
unsafe_pinned!(future: F);
unsafe_pinned!(timeout: Delay);
}
impl<F> Future for Timeout<F>
where
F: TryFuture,
F::Error: From<io::Error>,
{
type Output = Result<F::Ok, F::Error>;
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
match self.as_mut().future().try_poll(cx) {
Poll::Pending => {}
other => return other,
}
if self.timeout().poll(cx).is_ready() {
let err = Err(io::Error::new(io::ErrorKind::TimedOut, "future timed out").into());
Poll::Ready(err)
} else {
Poll::Pending
}
}
}
/// An extension trait for streams which provides convenient accessors for
/// timing out execution and such.
pub trait TryStreamExt: TryStream + Sized {
/// Creates a new stream which will take at most `dur` time to yield each
/// item of the stream.
///
/// This combinator creates a new stream which wraps the receiving stream
/// in a timeout-per-item. The stream returned will resolve in at most
/// `dur` time for each item yielded from the stream. The first item's timer
/// starts when this method is called.
///
/// If a stream's item completes before `dur` elapses then the timer will be
/// reset for the next item. If the timeout elapses, however, then an error
/// will be yielded on the stream and the timer will be reset.
fn timeout(self, dur: Duration) -> TimeoutStream<Self>
where
Self::Error: From<io::Error>,
{
TimeoutStream {
timeout: Delay::new(dur),
dur,
stream: self,
}
}
}
impl<S: TryStream> TryStreamExt for S {}
/// Stream returned by the `StreamExt::timeout` method.
#[derive(Debug)]
pub struct TimeoutStream<S>
where
S: TryStream,
S::Error: From<io::Error>,
{
timeout: Delay,
dur: Duration,
stream: S,
}
impl<S> TimeoutStream<S>
where
S: TryStream,
S::Error: From<io::Error>,
{
unsafe_pinned!(timeout: Delay);
unsafe_pinned!(stream: S);
}
impl<S> Stream for TimeoutStream<S>
where
S: TryStream,
S::Error: From<io::Error>,
{
type Item = Result<S::Ok, S::Error>;
fn poll_next(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Option<Self::Item>> {
let dur = self.dur;
let r = self.as_mut().stream().try_poll_next(cx);
match r {
Poll::Pending => {}
other => {
self.as_mut().timeout().reset(dur);
return other;
}
}
if self.as_mut().timeout().poll(cx).is_ready() {
self.as_mut().timeout().reset(dur);
Poll::Ready(Some(Err(io::Error::new(
io::ErrorKind::TimedOut,
"stream item timed out",
)
.into())))
} else {
Poll::Pending
}
}
}