Struct zstd::stream::zio::Reader

pub struct Reader<R, D> { /* private fields */ }

Implements the Read API around an Operation.

This can be used to wrap a raw in-memory operation in a read-focused API.

It can wrap either a compression or decompression operation, and pulls input data from a wrapped Read.

Implementations

impl<R, D> Reader<R, D>

pub fn new(reader: R, operation: D) -> Self

Creates a new Reader.

reader will be used to pull input data for the given operation.

pub fn set_single_frame(&mut self)

Sets self to stop after the first decoded frame.

pub fn operation_mut(&mut self) -> &mut D

Returns a mutable reference to the underlying operation.

pub fn reader_mut(&mut self) -> &mut R

Returns a mutable reference to the underlying reader.

pub fn reader(&self) -> &R

Returns a reference to the underlying reader.

pub fn into_inner(self) -> R

Returns the inner reader.

pub fn flush(&mut self, output: &mut [u8]) -> Result<usize>where
    D: Operation,

Flush any internal buffer.

For encoders, this ensures all input consumed so far is compressed.

Trait Implementations

impl<R, D> Read for Reader<R, D>where
    R: BufRead,
    D: Operation,

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.