Struct throttled_reader::ThrottledReader

pub struct ThrottledReader<R> { /* private fields */ }

ThrottleReader proxies an io::Read, but enforces a budget on how many read calls can be made to the underlying reader.

Implementations

impl<R> ThrottledReader<R>

pub fn new(reader: R) -> Self

Construct a new throttler that wraps the given reader.

The new ThrottledReader initially has no limit.

pub fn set_limit(&mut self, limit: usize)

Set the number of read calls allowed to the underlying reader.

pub fn unthrottle(&mut self)

Remove the limit on how many read calls can be issued to the underlying reader.

pub fn remaining(&self) -> Option<usize>

Check how many more read calls may be issued to the underlying reader.

Returns None if the reader is not currently throttled.

pub fn into_inner(self) -> R

Extract the underlying reader.

Trait Implementations

impl<R: Debug> Debug for ThrottledReader<R>

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

Formats the value using the given formatter.

impl<R> Default for ThrottledReader<R>where
    R: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<R> Deref for ThrottledReader<R>

type Target = R

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<R> DerefMut for ThrottledReader<R>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<R> From<R> for ThrottledReader<R>

fn from(reader: R) -> Self

Converts to this type from the input type.

impl<R: Hash> Hash for ThrottledReader<R>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<R: Ord> Ord for ThrottledReader<R>

fn cmp(&self, other: &ThrottledReader<R>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<R: PartialEq> PartialEq<ThrottledReader<R>> for ThrottledReader<R>

fn eq(&self, other: &ThrottledReader<R>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R: PartialOrd> PartialOrd<ThrottledReader<R>> for ThrottledReader<R>

fn partial_cmp(&self, other: &ThrottledReader<R>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R> Read for ThrottledReader<R>where
    R: 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.

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, Global>) -> 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 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)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adaptor 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<R: Eq> Eq for ThrottledReader<R>

impl<R> StructuralEq for ThrottledReader<R>

impl<R> StructuralPartialEq for ThrottledReader<R>