Struct lzzzz::lz4f::BufReadDecompressor

pub struct BufReadDecompressor<'a, R: BufRead> { /* private fields */ }

The BufRead-based streaming decompressor.

Example

use lzzzz::lz4f::BufReadDecompressor;
use std::{
    fs::File,
    io::{prelude::*, BufReader},
};

let mut f = File::open("foo.lz4")?;
let mut b = BufReader::new(f);
let mut r = BufReadDecompressor::new(&mut b)?;

let mut buf = Vec::new();
r.read_to_end(&mut buf)?;

Implementations

impl<'a, R: BufRead> BufReadDecompressor<'a, R>

pub fn new(reader: R) -> Result<Self>

Creates a new BufReadDecompressor<R>.

pub fn set_dict<D>(&mut self, dict: D)

where D: Into<Cow<'a, [u8]>>,

Sets the dictionary.

pub fn read_frame_info(&mut self) -> Result<FrameInfo>

Reads the frame header and returns FrameInfo.

Calling this function before any Read or BufRead operations does not consume the frame body.

pub fn into_inner(self) -> R

Returns ownership of the reader.

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

Returns a mutable reference to the reader.

pub fn get_ref(&self) -> &R

Returns a shared reference to the reader.

Trait Implementations

impl<R: BufRead> BufRead for BufReadDecompressor<'_, R>

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

fn has_data_left(&mut self) -> Result<bool, Error>

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

Check if the underlying Read has any data left to be read.

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

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

Skip all bytes until the delimiter byte or EOF is reached.

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

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<R> Debug for BufReadDecompressor<'_, R>

where R: BufRead + Debug,

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

Formats the value using the given formatter.

impl<R: BufRead> Read for BufReadDecompressor<'_, 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>

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

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