Struct zstd::stream::zio::Reader

[+] Show declaration

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

[−] Expand description

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.

Trait Implementations

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

[+] Show hidden undocumented items

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.

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

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

pub 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.

pub 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.

pub 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.

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

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

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

Read the exact number of bytes required to fill buf.

pub fn by_ref(&mut self) -> &mut Self[−]

Creates a “by reference” adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>[−]

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

pub fn take(self, limit: u64) -> Take<Self>[−]

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