Struct FrameDecoder

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

A reader for decompressing the LZ4 frame format

This Decoder wraps any other reader that implements io::Read. Bytes read will be decompressed according to the LZ4 frame format.

Example 1

Deserializing json values out of a compressed file.

let compressed_input = std::fs::File::open("datafile").unwrap();
let mut decompressed_input = lz4_flex::frame::FrameDecoder::new(compressed_input);
let json: serde_json::Value = serde_json::from_reader(decompressed_input).unwrap();

Example

Deserializing multiple json values out of a compressed file

let compressed_input = std::fs::File::open("datafile").unwrap();
let mut decompressed_input = lz4_flex::frame::FrameDecoder::new(compressed_input);
loop {
    match serde_json::from_reader::<_, serde_json::Value>(&mut decompressed_input) {
        Ok(json) => { println!("json {:?}", json); }
        Err(e) if e.is_eof() => break,
        Err(e) => panic!("{}", e),
    }
}

Implementations

impl<R: Read> FrameDecoder<R>

pub fn new(rdr: R) -> FrameDecoder<R>

Creates a new Decoder for the specified reader.

pub fn get_ref(&self) -> &R

Gets a reference to the underlying reader in this decoder.

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

Gets a mutable reference to the underlying reader in this decoder.

Note that mutation of the stream may result in surprising results if this decoder is continued to be used.

pub fn into_inner(self) -> R

Consumes the FrameDecoder and returns the underlying reader.

Trait Implementations

impl<R: Read> BufRead for FrameDecoder<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)

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

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

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

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

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

Reads 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 + Read> Debug for FrameDecoder<R>

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

Formats the value using the given formatter.

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_to_string(&mut self, buf: &mut String) -> Result<usize>

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

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

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

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