Struct XzWriterMt 

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

Available on crate features xz and encoder and std only.

A multi-threaded XZ compressor.

Implementations

impl<W: Write> XzWriterMt<W>

pub fn new(inner: W, options: XzOptions, num_workers: u32) -> Result<Self>

Creates a new multi-threaded XZ writer.

• inner: The writer to write compressed data to.
• options: The XZ options used for compressing. Block size must be set when using the multi-threaded encoder. If you need just one block, then use the single-threaded encoder.
• num_workers: The maximum number of worker threads for compression. Currently capped at 256 threads.

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

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

pub fn into_inner(self) -> W

Consume the XzWriterMt and return the inner writer.

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

Finishes the compression and returns the underlying writer.

Trait Implementations

impl<W: Write> Write for XzWriterMt<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.