Struct LzmaWriter 

pub struct LzmaWriter<W: Write> { /* private fields */ }

Available on crate feature encoder only.

A single-threaded LZMA compressor.

Implementations

impl<W: Write> LzmaWriter<W>

pub fn new( out: W, options: &LzmaOptions, use_header: bool, use_end_marker: bool, expected_uncompressed_size: Option<u64>, ) -> Result<LzmaWriter<W>>

Creates a new LZMA writer with full control over formatting options.

pub fn new_use_header( out: W, options: &LzmaOptions, input_size: Option<u64>, ) -> Result<Self>

Creates a new LZMA writer that includes a .lzma header with the specified input size.

pub fn new_no_header( out: W, options: &LzmaOptions, use_end_marker: bool, ) -> Result<Self>

Creates a new LZMA writer without a .lzma header.

pub fn auto_finish(self) -> AutoFinisher<Self>

Returns a wrapper around self that will finish the stream on drop.

pub fn props(&self) -> u8

Returns the LZMA properties byte.

pub fn get_uncompressed_size(&self) -> u64

Returns the number of uncompressed bytes written so far.

pub fn into_inner(self) -> W

Unwraps the writer, returning the underlying writer.

pub fn inner(&self) -> &W

Returns a reference to the inner writer.

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

Returns a mutable reference to the inner writer.

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

Finishes the compression and returns the underlying writer.

Trait Implementations

impl<W: Write> Write for LzmaWriter<W>

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

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

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

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, args: Arguments<'_>) -> Result<(), Error>

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

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

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