Skip to content

Add future::delay #349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Oct 29, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions src/future/delay.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
use std::pin::Pin;
use std::time::Duration;

use futures_timer::Delay;

use crate::future::Future;
use crate::task::{Context, Poll};

/// Creates a future that is delayed before it starts yielding items.
///
/// # Examples
///
/// ```
/// # async_std::task::block_on(async {
/// use async_std::future;
/// use std::time::Duration;

/// let a = future::delay(future::ready(1) ,Duration::from_millis(2000));
/// dbg!(a.await);
/// # })
/// ```
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[cfg(any(feature = "unstable", feature = "docs"))]
pub fn delay<F>(f: F, dur: Duration) -> DelayFuture<F>
where
F: Future,
{
DelayFuture::new(f, dur)
}

#[doc(hidden)]
#[derive(Debug)]
pub struct DelayFuture<F> {
future: F,
delay: Delay,
}

impl<F> DelayFuture<F> {
pin_utils::unsafe_pinned!(future: F);
pin_utils::unsafe_pinned!(delay: Delay);

pub fn new(future: F, dur: Duration) -> DelayFuture<F> {
let delay = Delay::new(dur);

DelayFuture { future, delay }
}
}

impl<F: Future> Future for DelayFuture<F> {
type Output = F::Output;

fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
match self.as_mut().delay().poll(cx) {
Poll::Pending => Poll::Pending,
Poll::Ready(_) => match self.future().poll(cx) {
Poll::Ready(v) => Poll::Ready(v),
Poll::Pending => Poll::Pending,
},
}
}
}
2 changes: 2 additions & 0 deletions src/future/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ mod timeout;
cfg_if! {
if #[cfg(any(feature = "unstable", feature = "docs"))] {
mod into_future;
mod delay;

pub use into_future::IntoFuture;
pub use delay::delay;
}
}