Struct LzfseReader

pub struct LzfseReader<'a, I: Read>(/* private fields */);

LZFSE decoding reader.

Exposes a LZFSE decoder via the Read interface that decodes from an inner reader.

Instances are created using LzfseRingDecoder::reader.

Examples

use lzfse_rust::LzfseRingDecoder;
use std::io::{self, Read};

fn main() -> io::Result<()> {
    // "test" string encoded.
    let enc = vec![
        0x62, 0x76, 0x78, 0x2d, 0x04, 0x00, 0x00, 0x00, 0x74, 0x65, 0x73, 0x74, 0x62, 0x76,
        0x78, 0x24,
    ];
    let mut decoder = LzfseRingDecoder::default();
    let inner = enc.as_slice();
    let mut reader = decoder.reader(inner);
    let mut dec = Vec::default();
    reader.read_to_end(&mut dec)?;
    assert_eq!(dec, b"test");
    Ok(())
}

Implementations

impl<'a, I: Read> LzfseReader<'a, I>

pub fn into_inner(self) -> I

Unwraps and returns the underlying reader.

Note that unless all data has been read, in which case the underlying reader also has been fully read, the position of underlying reader in undefined.

Trait Implementations

impl<'a, I: Read> Debug for LzfseReader<'a, I>

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

Formats the value using the given formatter.

impl<'a, I: Read> Read for LzfseReader<'a, I>

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