Struct ffsend_api::pipe::PipeReader

pub struct PipeReader<P> where
    P: Pipe,  { /* fields omitted */ }

A simple generic reader implementation for a pipe.

This type may be used as simple reader implementation for any pipe. For better performance it is better to implement a custom reader in some situations.

It is recommended to expose a custom reader type definition for each of your pipes like this:

pub type MyReader = PipeReader<MyPipe>;

Trait Implementations

impl<P> PipeRead<P> for PipeReader<P> where
    P: Pipe, 

fn new(pipe: P, inner: Box<dyn Read>) -> Self

Wrap the given inner reader, transform data using crypt.

impl<P> Read for PipeReader<P> where
    P: Pipe, 

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.