Struct tokio_stream::wrappers::IntervalStream

pub struct IntervalStream { /* fields omitted */ }

This is supported on crate feature time only.

A wrapper around Interval that implements Stream.

Implementations

impl IntervalStream

pub fn new(interval: Interval) -> Self

Create a new IntervalStream.

pub fn into_inner(self) -> Interval

Get back the inner Interval.

Trait Implementations

impl AsMut<Interval> for IntervalStream

fn as_mut(&mut self) -> &mut Interval

Performs the conversion.

impl AsRef<Interval> for IntervalStream

fn as_ref(&self) -> &Interval

Performs the conversion.

impl Debug for IntervalStream

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

Formats the value using the given formatter.

impl Stream for IntervalStream

type Item = Instant

Values yielded by the stream.

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

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.