Struct DecompressorReader

pub struct DecompressorReader<R>
where
    R: BufRead,
{ /* private fields */ }

Wraps a reader and decompresses its output.

Examples

Suppose the file test.brotli contains brotli compressed data. Let’s try to decompress it:

use std::fs::File;
use std::io::Read;

use brotlic::DecompressorWriter;

let mut input = File::open("test.brotli")?; // test.brotli is brotli compressed
let mut output = String::new();

input.read_to_string(&mut output)?;

println!("Decompressed text: {}", output);

Implementations

impl<R> DecompressorReader<R>

where R: BufRead,

pub fn new(inner: R) -> DecompressorReader<R>

Creates a new DecompressorReader<R> with a newly created decoder.

Panics

Panics if the decoder fails to be allocated or initialized

pub fn with_decoder(decoder: BrotliDecoder, inner: R) -> DecompressorReader<R>

Creates a new DecompressorReader<R> with a specified decoder.

Examples

use std::io::Read;

use brotlic::{BrotliDecoderOptions, DecompressorReader};

let decoder = BrotliDecoderOptions::new()
    .disable_ring_buffer_reallocation(true)
    .build()?;

let source = [11, 2, 128, 104, 101, 108, 108, 111, 3]; // decompresses to "hello"
let mut decompressor = DecompressorReader::with_decoder(decoder, source.as_slice());

pub fn get_ref(&self) -> &R

Gets a reference to the underlying reader

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

Gets a mutable reference to the underlying reader.

It is inadvisable to directly read from the underlying reader.

pub fn into_inner(self) -> Result<R, IntoInnerError<DecompressorReader<R>>>

Unwraps this DecompressorReader<R>, returning the underlying reader.

Errors

An Err will be returned if the decompression stream has not been finished.

pub fn into_parts(self) -> (R, BrotliDecoder)

Disassembles this DecompressorReader<R>, returning the underlying reader and decoder.

into_parts makes no attempt to validate that the decompression stream finished and cannot fail.

Trait Implementations

impl<R> Debug for DecompressorReader<R>

where R: Debug + BufRead,

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

Formats the value using the given formatter.

impl<R> Read for DecompressorReader<R>

where R: BufRead,

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

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<'_>) -> 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)

Reads the exact number of bytes required to fill cursor.

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

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