Struct Interval

pub struct Interval { /* private fields */ }

Interval returned by interval

This type allows you to wait on a sequence of instants with a certain duration between each instant.

Implementations

impl Interval

pub fn new(period: Millis) -> Interval

Create new sleep future

pub async fn tick(&self)

pub fn poll_tick(&self, cx: &mut Context<'_>) -> Poll<()>

Trait Implementations

impl Debug for Interval

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Stream for Interval

type Item = ()

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.