Struct ticktock::throttled_io::ThrottledIo

pub struct ThrottledIo<T> { /* fields omitted */ }

A wrapper that limits the maximum read/write-rate.

When asked to read bytes, the reader will always pause after a successful read to never exceed the specified maximum read rate.

Methods

impl<T> ThrottledIo<T>

Important traits for ThrottledIo<T>

impl<T> Read for ThrottledIo<T> where
    T: Read, impl<T> Write for ThrottledIo<T> where
    T: Write, 

pub fn new(io: T, bytes_per_second: u32) -> ThrottledIo<T>

Create a new throttled reader with a specified maximum rate.

Important traits for ThrottledIo<T>

impl<T> Read for ThrottledIo<T> where
    T: Read, impl<T> Write for ThrottledIo<T> where
    T: Write, 

pub fn new_with_start_time(
    io: T,
    bytes_per_second: u32,
    now: Instant
) -> ThrottledIo<T>

Create a new throttled reader, with specified start time.

Note: If now is in the future, calls to read will likely panic.

pub fn into_inner(self) -> T

Return the inner reader/writer.

Trait Implementations

impl<T: Debug> Debug for ThrottledIo<T>

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

Formats the value using the given formatter.

impl<T> Read for ThrottledIo<T> where
    T: Read, 

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

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

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<T> Write for ThrottledIo<T> where
    T: Write, 

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

Write a buffer into this writer, returning how many bytes were written.

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

Flush 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 write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

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

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

Creates a "by reference" adaptor for this instance of Write.