Struct FrameDecoder 

pub struct FrameDecoder<R: Read> { /* private fields */ }

Streaming zstd decompressor implementing Read.

Wraps a reader of compressed data and yields decompressed bytes. Supports multi-frame streams and skippable frames.

use std::io::Read;

let data = b"hello, streaming world!".repeat(100);
let compressed = zrip::compress(&data, 1).unwrap();

let mut decoder = zrip::FrameDecoder::new(&compressed[..]);
let mut output = Vec::new();
decoder.read_to_end(&mut output).unwrap();
assert_eq!(output, data);

Implementations

impl<R: Read> FrameDecoder<R>

pub fn new(reader: R) -> Self

Creates a decoder with DEFAULT_DECOMPRESS_LIMIT.

pub fn with_limit(reader: R, max_output: usize) -> Self

Creates a decoder with an explicit output size limit.

pub fn with_dict(reader: R, dict: Dictionary) -> Self

Creates a decoder with a dictionary and default output limit.

pub fn with_dict_and_limit( reader: R, dict: Dictionary, max_output: usize, ) -> Self

Creates a decoder with a dictionary and explicit output limit.

pub fn into_inner(self) -> R

Consumes the decoder and returns the underlying reader.

pub fn reset(&mut self, new_reader: R) -> R

Installs a new reader for the next frame, keeping all internal buffers allocated. Returns the previous reader.

Trait Implementations

impl<R: Read> Read for FrameDecoder<R>

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>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_, u8>) -> 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<'_, u8>, ) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter 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.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

fn read_le<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in little-endian order.

fn read_be<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in big-endian order.