Struct lzma_rs::decompress::Stream

pub struct Stream<W>where
    W: Write,{ /* private fields */ }

Available on stream only.

Lzma decompressor that can process multiple chunks of data using the io::Write interface.

Implementations

impl<W> Stream<W>where
    W: Write,

pub fn new(output: W) -> Self

Initialize the stream. This will consume the output which is the sink implementing io::Write that will receive decompressed bytes.

pub fn new_with_options(options: &Options, output: W) -> Self

Initialize the stream with the given options. This will consume the output which is the sink implementing io::Write that will receive decompressed bytes.

pub fn get_output(&self) -> Option<&W>

Get a reference to the output sink

pub fn get_output_mut(&mut self) -> Option<&mut W>

Get a mutable reference to the output sink

pub fn finish(self) -> Result<W>

Consumes the stream and returns the output sink. This also makes sure we have properly reached the end of the stream.

Trait Implementations

impl<W> Debug for Stream<W>where
    W: Write + Debug,

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

Formats the value using the given formatter.

impl<W> Write for Stream<W>where
    W: Write,

fn flush(&mut self) -> Result<()>

Flushes the output sink. The internal buffer isn’t flushed to avoid corrupting the internal state. Instead, call finish() to finalize the stream and flush all remaining internal data.

fn write(&mut self, data: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Selfwhere
    Self: Sized,

Creates a “by reference” adapter for this instance of Write.