Struct LzmaReader 

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

A single-threaded LZMA decompressor.

Examples

use std::io::Read;

use lzma_rust2::LzmaReader;

let compressed: Vec<u8> = vec![
    93, 0, 0, 128, 0, 255, 255, 255, 255, 255, 255, 255, 255, 0, 36, 25, 73, 152, 111, 22, 2,
    140, 232, 230, 91, 177, 71, 198, 206, 183, 99, 255, 255, 60, 172, 0, 0,
];
let mut reader = LzmaReader::new_mem_limit(compressed.as_slice(), u32::MAX, None).unwrap();
let mut buf = [0; 1024];
let mut out = Vec::new();
loop {
    let n = reader.read(&mut buf).unwrap();
    if n == 0 {
        break;
    }
    out.extend_from_slice(&buf[..n]);
}
assert_eq!(out, b"Hello, world!");

Implementations

impl<R> LzmaReader<R>

pub fn into_inner(self) -> R

Unwraps the reader, returning the underlying reader.

pub fn inner(&self) -> &R

Returns a reference to the inner reader.

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

Returns a mutable reference to the inner reader.

impl<R: Read> LzmaReader<R>

pub fn new_mem_limit( reader: R, mem_limit_kb: u32, preset_dict: Option<&[u8]>, ) -> Result<Self>

Creates a new .lzma file format decompressor with an optional memory usage limit.

• mem_limit_kb - memory usage limit in kibibytes (KiB). u32::MAX means no limit.
• preset_dict - preset dictionary or None to use no preset dictionary.

pub fn new_with_props( reader: R, uncomp_size: u64, props: u8, dict_size: u32, preset_dict: Option<&[u8]>, ) -> Result<Self>

Creates a new input stream that decompresses raw LZMA data (no .lzma header) from reader optionally with a preset dictionary.

• reader - the reader to read compressed data from.
• uncomp_size - the uncompressed size of the data to be decompressed.
• props - the LZMA properties byte.
• dict_size - the LZMA dictionary size.
• preset_dict - preset dictionary or None to use no preset dictionary.

pub fn new( reader: R, uncomp_size: u64, lc: u32, lp: u32, pb: u32, dict_size: u32, preset_dict: Option<&[u8]>, ) -> Result<Self>

Creates a new input stream that decompresses raw LZMA data (no .lzma header) from reader optionally with a preset dictionary.

• reader - the input stream to read compressed data from.
• uncomp_size - the uncompressed size of the data to be decompressed.
• lc - the number of literal context bits.
• lp - the number of literal position bits.
• pb - the number of position bits.
• dict_size - the LZMA dictionary size.
• preset_dict - preset dictionary or None to use no preset dictionary.

Trait Implementations

impl<R: Read> Read for LzmaReader<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>

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