futures_stream_ext

Struct Throttle

Source 
pub struct Throttle<S: Stream, T: Throttler<<S as Stream>::Item>> { /* private fields */ }
Expand description

Throttled stream

Implementations§

Source§

impl<S, T> Throttle<S, T>
where S: Stream, T: Throttler<<S as Stream>::Item>,

Source

pub const fn new( stream: S, throttler: T, poll_next_max_ready_count: NonZeroUsize, ) -> Self

Trait Implementations§

Source§

impl<S: Debug + Stream, T: Debug + Throttler<<S as Stream>::Item>> Debug for Throttle<S, T>
where S::Item: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S, T> Stream for Throttle<S, T>
where S: Stream, T: Throttler<<S as Stream>::Item>,

Source§

type Item = <S as Stream>::Item

Values yielded by the stream.
Source§

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. Read more
Source§

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

Returns the bounds on the remaining length of the stream. Read more
Source§

impl<'__pin, S: Stream, T: Throttler<<S as Stream>::Item>> Unpin for Throttle<S, T>
where PinnedFieldsOf<__Origin<'__pin, S, T>>: Unpin,

Auto Trait Implementations§

§

impl<S, T> Freeze for Throttle<S, T>
where S: Freeze, T: Freeze, <S as Stream>::Item: Freeze,

§

impl<S, T> RefUnwindSafe for Throttle<S, T>
where S: RefUnwindSafe, T: RefUnwindSafe, <S as Stream>::Item: RefUnwindSafe,

§

impl<S, T> Send for Throttle<S, T>
where S: Send, T: Send, <S as Stream>::Item: Send,

§

impl<S, T> Sync for Throttle<S, T>
where S: Sync, T: Sync, <S as Stream>::Item: Sync,

§

impl<S, T> UnwindSafe for Throttle<S, T>
where S: UnwindSafe, T: UnwindSafe, <S as Stream>::Item: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<S> StreamExt for S
where S: Stream,

Source§

fn throttle<T>( self, throttler: T, poll_next_max_ready_count: NonZeroUsize, ) -> Throttle<Self, T>
where Self: Stream + Sized, T: Throttler<Self::Item>,

Throttle an input stream Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T, E> TryStream for S
where S: Stream<Item = Result<T, E>> + ?Sized,

Source§

type Ok = T

The type of successful values yielded by this future
Source§

type Error = E

The type of failures yielded by this future
Source§

fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more