Struct ruzstd::streaming_decoder::StreamingDecoder

pub struct StreamingDecoder<'a> {
    pub decoder: FrameDecoder,
    // some fields omitted
}

High level decoder that implements a io::Read that can be used with io::Read::read_to_end / io::Read::read_exact or passing this to another library / module as a source for the decoded content

The lower level FrameDecoder by comparison allows for finer grained control but need sto have it's decode_blocks method called continously to decode the zstd-frame.

Fields

decoder: FrameDecoder

Methods

impl<'a> StreamingDecoder<'a>

pub fn new(source: &'a mut dyn Read) -> Result<StreamingDecoder, String>

pub fn new_with_decoder(
    source: &'a mut dyn Read,
    decoder: FrameDecoder
) -> Result<StreamingDecoder, String>

Important traits for FrameDecoder

impl Read for FrameDecoder

pub fn inner(self) -> FrameDecoder

Trait Implementations

impl<'a> Read for StreamingDecoder<'a>

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.