Struct GlobalRateLimitedWriter 

pub struct GlobalRateLimitedWriter<W> {
    inner: W,
    state: DirectionState,
}

An AsyncWrite wrapper that acquires bandwidth before writing bytes.

A single byte is one token which we acquire from the shared pool. A single AsyncWrite::poll_write is capped to the pool’s capacity so a large buffer has to go in written several chunks.

Fields

inner: W

The underlying writer bytes are forwarded to.

state: DirectionState

The per-direction state holding an acquirer and permit.

Implementations

impl<W> GlobalRateLimitedWriter<W>

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

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

impl<W> GlobalRateLimitedWriter<W>

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

Constructor.

This writer is rate limited as 1 byte per token.

Each write requests at most max_chunk tokens.

Trait Implementations

impl<W> AsyncWrite for GlobalRateLimitedWriter<W>

where W: AsyncWrite,

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

Attempt to write bytes from buf into the object.

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

Attempt to flush the object, ensuring that any buffered data reach their destination.

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

Attempt to close the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<W: Debug> Debug for GlobalRateLimitedWriter<W>

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

Formats the value using the given formatter.

impl<'pin, W> Unpin for GlobalRateLimitedWriter<W>

where PinnedFieldsOf<__GlobalRateLimitedWriter<'pin, W>>: Unpin,