Struct Reader 

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

Available on crate feature std only.

Decompresses while reading from a compressed source.

Reading past the end of the compressed stream returns 0. Data after the stream is left unread in the source as far as the 32 KiB buffer allows (use Reader::into_inner with care), and the stream must be complete: a source that ends early is UnexpectedEof.

Examples

use std::io::Read;

use compress_lib::{Format, io::Reader, zlib};

let packed = zlib::compress(b"read me");
let mut out = Vec::new();
Reader::new(&packed[..], Format::Zlib).read_to_end(&mut out)?;
assert_eq!(out, b"read me");

Implementations

impl<R: Read> Reader<R>

pub fn new(inner: R, format: Format) -> Self

Reads format from inner with the default limits.

Examples

let r = compress_lib::io::Reader::new(&b""[..], compress_lib::Format::Gzip);

pub fn with_limits(self, limits: Limits) -> Self

Sets the limits checked while decoding.

Examples

use compress_lib::{Format, Limits, io::Reader};

let r = Reader::new(&b""[..], Format::Gzip).with_limits(Limits::new().with_max_output(1 << 20));

pub fn into_inner(self) -> R

The source, consuming the reader.

Examples

let r = compress_lib::io::Reader::new(&b"xyz"[..], compress_lib::Format::Gzip);
let _source: &[u8] = r.into_inner();

Trait Implementations

impl<R: Debug> Debug for Reader<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R: Read> Read for Reader<R>

fn read(&mut self, out: &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.