Struct governor::state::direct::RatelimitedStream

pub struct RatelimitedStream<'a, S: Stream, D: DirectStateStore, C: Clock, MW: RateLimitingMiddleware<C::Instant>> { /* private fields */ }

A Stream combinator which will limit the rate of items being received.

This is produced by the StreamRateLimitExt::ratelimit_stream and StreamRateLimitExt::ratelimit_stream_with_jitter methods.

Implementations

impl<'a, S: Stream, D: DirectStateStore, C: Clock, MW: RateLimitingMiddleware<C::Instant>> RatelimitedStream<'a, S, D, C, MW>

Conversion methods for the stream combinator.

pub fn get_ref(&self) -> &S

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

let inner = stream::repeat(());
let lim = RateLimiter::direct(Quota::per_second(nonzero!(10u32)));
let outer = inner.clone().ratelimit_stream(&lim);
assert!(outer.get_ref().size_hint().1.is_none());
assert_eq!(outer.size_hint(), outer.get_ref().size_hint());

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

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

let inner = stream::repeat(());
let lim = RateLimiter::direct(Quota::per_second(nonzero!(10u32)));
let mut outer = inner.clone().ratelimit_stream(&lim);
assert_eq!(block_on(outer.get_mut().next()), Some(()));

pub fn into_inner(self) -> (S, Option<S::Item>)

Consumes this combinator, returning the underlying stream and any item which it has already produced but which is still being held back in order to abide by the limiter.

let inner = stream::repeat(());
let lim = RateLimiter::direct(Quota::per_second(nonzero!(10u32)));
let mut outer = inner.clone().ratelimit_stream(&lim);
let (mut inner_again, _) = outer.into_inner();
assert_eq!(block_on(inner_again.next()), Some(()));

Trait Implementations

impl<'a, Item, S, D: DirectStateStore, C: Clock, MW: RateLimitingMiddleware<C::Instant>> Sink<Item> for RatelimitedStream<'a, S, D, C, MW>

where S: Unpin + Stream + Sink<Item>, S::Item: Unpin,

Pass-through implementation for futures::Sink if the Stream also implements it.

type Error = <S as Sink<Item>>::Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<'a, S, D: DirectStateStore, C, MW> Stream for RatelimitedStream<'a, S, D, C, MW>

where S: Unpin + Stream, S::Item: Unpin, Self: Unpin, C: ReasonablyRealtime + Clock, MW: RateLimitingMiddleware<C::Instant, NegativeOutcome = NotUntil<C::Instant>>,

Implements the futures::Stream combinator.

type Item = <S 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.