Struct tokio_timerfd::Interval

pub struct Interval { /* private fields */ }

A stream representing notifications at fixed interval

Implementations

impl Interval

pub fn new(at: Instant, duration: Duration) -> Result<Interval, IoError>

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_interval(duration: Duration) -> Result<Interval, IoError>

Creates new Interval that yields with interval of duration.

The function is shortcut for Interval::new(Instant::now() + duration, duration).

The duration argument must be a non-zero duration.

Panics

This function panics if duration is zero.

Trait Implementations

impl Stream for Interval

type Item = Result<(), IoError>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.