tokio/tokio-timer/src/interval.rs

use Sleep;

use futures::{Future, Stream, Poll};

use std::time::{Instant, Duration};

/// A stream representing notifications at fixed interval
#[derive(Debug)]
pub struct Interval {
    /// Future that completes the next time the `Interval` yields a value.
    sleep: Sleep,

    /// The duration between values yielded by `Interval`.
    duration: Duration,
}

impl Interval {
    /// Create a new `Interval` that starts at `at` and yields every `duration`
    /// interval after that.
    ///
    /// The `duration` argument must be a non-zero duration.
    ///
    /// # Panics
    ///
    /// This function panics if `duration` is zero.
    pub fn new(at: Instant, duration: Duration) -> Interval {
        assert!(duration > Duration::new(0, 0), "`duration` must be non-zero.");

        Interval::new_with_sleep(Sleep::new(at), duration)
    }

    pub(crate) fn new_with_sleep(sleep: Sleep, duration: Duration) -> Interval {
        Interval {
            sleep,
            duration,
        }
    }
}

impl Stream for Interval {
    type Item = Instant;
    type Error = ::Error;

    fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error> {
        // Wait for the sleep to be done
        let _ = try_ready!(self.sleep.poll());

        // Get the `now` by looking at the `sleep` deadline
        let now = self.sleep.deadline();

        // The next interval value is `duration` after the one that just
        // yielded.
        self.sleep.reset(now + self.duration);

        // Return the current instant
        Ok(Some(now).into())
    }
}