Struct nyx::read::Reader

pub struct Reader<R, F> { /* fields omitted */ }

A reader that extends the read and read_vectored implementations to report their throughput every second.

Methods

impl<R, F> Reader<R, F>

pub fn inner(self) -> R

Consumes the reader and returns the original reader.

Trait Implementations

impl<R: Eq, F: Eq> Eq for Reader<R, F>

impl<R: Clone, F: Clone> Clone for Reader<R, F>

Important traits for Reader<R, F>

impl<R: Read, F: FnMut(Bps)> Read for Reader<R, F>

fn clone(&self) -> Reader<R, F>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: PartialOrd, F: PartialOrd> PartialOrd<Reader<R, F>> for Reader<R, F>

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

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

fn lt(&self, other: &Reader<R, F>) -> bool

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

fn le(&self, other: &Reader<R, F>) -> bool

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

fn gt(&self, other: &Reader<R, F>) -> bool

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

fn ge(&self, other: &Reader<R, F>) -> bool

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

impl<R: PartialEq, F: PartialEq> PartialEq<Reader<R, F>> for Reader<R, F>

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

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

fn ne(&self, other: &Reader<R, F>) -> bool

This method tests for !=.

impl<R: Ord, F: Ord> Ord for Reader<R, F>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<R: Copy, F: Copy> Copy for Reader<R, F>

impl<R: Hash, F: Hash> Hash for Reader<R, F>

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, 

Feeds a slice of this type into the given [Hasher].

impl<R: Debug, F: Debug> Debug for Reader<R, F>

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

Formats the value using the given formatter.

impl<R: Read, F: FnMut(Bps)> Read for Reader<R, F>

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>

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.