Struct XzStream 

pub struct XzStream { /* private fields */ }

Available on crate feature xz only.

Sans-I/O XZ stream decoder.

Implements a buffer-pair API: call process() repeatedly with input/output buffers until Status::StreamEnd is returned.

Limitations

A block may contain at most one non-LZMA2 filter (a single BCJ or Delta filter) preceding the terminating LZMA2 filter. Streams that chain multiple non-LZMA2 filters in a block are rejected with an error. Use the blocking XzReader to decode those.

Implementations

impl XzStream

pub fn new(allow_multiple_streams: bool) -> Self

Create a new XZ stream decoder.

If allow_multiple_streams is true, concatenated XZ streams are decoded sequentially until EOF.

pub fn total_in(&self) -> u64

Total bytes consumed from input across all process() calls.

pub fn total_out(&self) -> u64

Total bytes produced to output across all process() calls.

pub fn check_type(&self) -> Option<CheckType>

The integrity check type used by the current stream.

This is read from the stream header during decoding. Before the header has been parsed, returns CheckType::None.

pub fn process( &mut self, input: &[u8], output: &mut [u8], action: Action, ) -> Result<StreamResult>

Process available data from input into output.

Returns how many bytes were consumed/produced and the stream status. Call repeatedly until Status::StreamEnd is returned.