pub struct XzDecoder<W: Write> { /* private fields */ }Expand description
A compression stream which will have compressed data written to it and will write uncompressed data to an output stream. XzDecoder will no longer perform the finalization automatically in the next miner release, so you need to call XzDecoder::finish manually. If you want to automate the finalization process, please use XzDecoder::auto_finish.
Implementations§
Source§impl<W: Write> XzDecoder<W>
impl<W: Write> XzDecoder<W>
Sourcepub fn new(obj: W) -> XzDecoder<W> ⓘ
pub fn new(obj: W) -> XzDecoder<W> ⓘ
Creates a new decoding stream which will decode into obj one xz stream
from the input written to it.
Sourcepub fn new_parallel(obj: W) -> Self
pub fn new_parallel(obj: W) -> Self
Creates a new parallel decoding stream which will decode into obj one xz stream
from the input written to it.
Sourcepub fn new_multi_decoder(obj: W) -> XzDecoder<W> ⓘ
pub fn new_multi_decoder(obj: W) -> XzDecoder<W> ⓘ
Creates a new decoding stream which will decode into obj all the xz streams
from the input written to it.
Sourcepub fn new_stream(obj: W, stream: Stream) -> XzDecoder<W> ⓘ
pub fn new_stream(obj: W, stream: Stream) -> XzDecoder<W> ⓘ
Creates a new decoding stream which will decode all input written to it
into obj.
A custom stream can be specified to configure what format this decoder
will recognize or configure other various decoding options.
Sourcepub fn get_mut(&mut self) -> &mut W
pub fn get_mut(&mut self) -> &mut W
Acquires a mutable reference to the underlying writer.
Note that mutating the output/input state of the stream may corrupt this object, so care must be taken when using this method.
Sourcepub fn try_finish(&mut self) -> Result<()>
pub fn try_finish(&mut self) -> Result<()>
Attempt to finish this output stream, writing out final chunks of data.
Note that this function can only be used once data has finished being
written to the output stream. After this function is called then further
calls to write may result in a panic.
§Panics
Attempts to write data to this stream may result in a panic after this function is called.
Sourcepub fn finish(&mut self) -> Result<W>
pub fn finish(&mut self) -> Result<W>
Unwrap the underlying writer, finishing the compression stream.
Sourcepub fn total_out(&self) -> u64
pub fn total_out(&self) -> u64
Returns the number of bytes produced by the decompressor
Note that, due to buffering, this only bears any relation to
total_in() after a call to flush(). At that point,
total_in() / total_out() is the compression ratio.
Sourcepub fn total_in(&self) -> u64
pub fn total_in(&self) -> u64
Returns the number of bytes consumed by the decompressor (e.g. the number of bytes written to this stream.)
Sourcepub fn auto_finish(self) -> AutoFinishXzDecoder<W> ⓘ
pub fn auto_finish(self) -> AutoFinishXzDecoder<W> ⓘ
Convert to AutoFinishXzDecoder that impl Drop trait. AutoFinishXzDecoder automatically calls XzDecoder::try_finish method when exiting the scope.
Trait Implementations§
Source§impl<W: Read + Write> Read for XzDecoder<W>
impl<W: Read + Write> Read for XzDecoder<W>
Source§fn read(&mut self, buf: &mut [u8]) -> Result<usize>
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
1.36.0 · Source§fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
read, except that it reads into a slice of buffers. Read moreSource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector)1.0.0 · Source§fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
buf. Read more1.0.0 · Source§fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
buf. Read more1.6.0 · Source§fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf. Read moreSource§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
read_buf)Source§fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
read_buf)cursor. Read more1.0.0 · Source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Read. Read moreSource§impl<W: Write> Write for XzDecoder<W>
impl<W: Write> Write for XzDecoder<W>
Source§fn write(&mut self, data: &[u8]) -> Result<usize>
fn write(&mut self, data: &[u8]) -> Result<usize>
Source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector)1.0.0 · Source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored)