Struct tokio_stream::stream_ext::throttle::Throttle

pub struct Throttle<T> {
    delay: Sleep,
    duration: Duration,
    has_delayed: bool,
    stream: T,
}

Stream for the throttle function. This object is !Unpin. If you need it to implement Unpin you can pin your throttle like this: Box::pin(your_throttle).

Fields

delay: Sleep

duration: Duration

has_delayed: bool

stream: T

Implementations

impl<T> Throttle<T>

pub fn get_ref(&self) -> &T

Acquires a reference to the underlying stream that this combinator is pulling from.

pub fn get_mut(&mut self) -> &mut T

Acquires a mutable reference to the underlying stream that this combinator is pulling from.

Note that care must be taken to avoid tampering with the state of the stream which may otherwise confuse this combinator.

pub fn into_inner(self) -> T

Consumes this combinator, returning the underlying stream.

Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.

Trait Implementations

impl<T: Debug> Debug for Throttle<T>

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

Formats the value using the given formatter.

impl<T: Stream> Stream for Throttle<T>

type Item = <T as Stream>::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.

impl<'__pin, T> Unpin for Throttle<T>

where PinnedFieldsOf<__Origin<'__pin, T>>: Unpin,