Struct GlobalRateLimitedReader 

pub struct GlobalRateLimitedReader<R> {
    inner: R,
    state: DirectionState,
}

An AsyncRead wrapper that acquires bandwidth before yielding bytes.

Every byte read costs one token from the shared pool. A single AsyncRead::poll_read is capped to the pool’s bandwidth so a large buffer is filled in many chunks.

Fields

inner: R

The underlying reader bytes are read from.

state: DirectionState

The per-direction state holding an acquirer and permit.

Implementations

impl<R> GlobalRateLimitedReader<R>

pub(crate) fn project<'pin>( self: Pin<&'pin mut Self>, ) -> __GlobalRateLimitedReaderProjection<'pin, R>

pub(crate) fn project_ref<'pin>( self: Pin<&'pin Self>, ) -> __GlobalRateLimitedReaderProjectionRef<'pin, R>

impl<R> GlobalRateLimitedReader<R>

pub fn new( inner: R, acquirer: BandwidthAcquirer, max_chunk: NonZero<usize>, ) -> Self

Construct a reader that spends one token per byte from the acquirer’s pool.

Each read requests at most max_chunk tokens.

Trait Implementations

impl<R> AsyncRead for GlobalRateLimitedReader<R>

where R: AsyncRead,

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<R: Debug> Debug for GlobalRateLimitedReader<R>

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

Formats the value using the given formatter.

impl<'pin, R> Unpin for GlobalRateLimitedReader<R>

where PinnedFieldsOf<__GlobalRateLimitedReader<'pin, R>>: Unpin,