Struct Limiter 

pub struct Limiter<S>
where
    S: Read + Write,
{
    pub stream: S,
    pub read_opt: Option<LimiterOptions>,
    pub write_opt: Option<LimiterOptions>,
    /* private fields */
}

A Limiter is a wrapper around a stream that implement Read and Write that limits the rate at which it can be read or written. The rate is given in byte/s.

Fields

stream: S

read_opt: Option<LimiterOptions>

write_opt: Option<LimiterOptions>

Implementations

impl<S> Limiter<S>

where S: Read + Write,

pub fn new( stream: S, read_opt: Option<LimiterOptions>, write_opt: Option<LimiterOptions>, ) -> Limiter<S>

Create a new Limiter with the given stream and rate limiting:

• window_length: The number of bytes that can be read or written in a given time window.
• window_time: The time window in which window_length bytes can be read or written.

We initialize the limiter as if one period has already passed so that the first read/write is instant.

pub fn get_stream(self) -> S

pub fn limits(&self) -> (bool, bool)

pub fn read_instant(&mut self, buf: &mut [u8]) -> Result<usize>

pub fn write_instant(&mut self, buf: &[u8]) -> Result<usize>

Trait Implementations

impl<S> Read for Limiter<S>

where S: Read + Write,

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Read a stream at a given rate. If the rate is 1 byte/s, it will take 1 second to read 1 byte. (except the first time which is instant) If you didn’t read for 10 secondes in this stream and you try to read 10 bytes, it will read instantly.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<S> Write for Limiter<S>

where S: Read + Write,

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a stream at a given rate. If the rate is 1 byte/s, it will take 1 second to write 1 byte. (except the first time which is instant) If you didn’t write for 10 secondes in this stream and you try to write 10 bytes, it will write instantly.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.