Struct RateLimitedWriter 

pub struct RateLimitedWriter<W: AsyncWrite, P: SleepProvider> { /* private fields */ }

A rate-limited async writer.

This can be used as a wrapper around an existing AsyncWrite writer.

Implementations

impl<W, P> RateLimitedWriter<W, P>

where W: AsyncWrite, P: SleepProvider,

pub fn new( writer: W, config: &RateLimitedWriterConfig, sleep_provider: P, ) -> Self

Create a new RateLimitedWriter.

pub fn inner(&self) -> &W

Access the inner AsyncWrite writer.

pub fn adjust( self: &mut Pin<&mut Self>, now: Instant, config: &RateLimitedWriterConfig, )

Adjust the refill rate and burst.

A rate and/or burst of 0 is allowed.

Trait Implementations

impl<W, P> AsyncWrite for RateLimitedWriter<W, P>

where W: AsyncWrite, P: SleepProvider,

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, P> AsyncWrite for RateLimitedWriter<W, P>

where W: AsyncWrite, P: SleepProvider,

Available on crate feature tokio only.

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

Attempt to write bytes from buf into the object.

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

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

fn poll_shutdown( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<IoResult<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<W: AsyncWrite, P: SleepProvider> Debug for RateLimitedWriter<W, P>

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

Formats the value using the given formatter.

impl<'pin, W: AsyncWrite, P: SleepProvider> Unpin for RateLimitedWriter<W, P>

where PinnedFieldsOf<__RateLimitedWriter<'pin, W, P>>: Unpin,