Struct xz::write::XzDecoder

pub struct XzDecoder<W> where
    W: Write,  { /* fields omitted */ }

A compression stream which will have compressed data written to it and will write uncompressed data to an output stream.

Implementations

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

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.

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.

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.

pub fn get_ref(&self) -> &W

Acquires a reference to the underlying writer.

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.

pub fn finish(&mut self) -> Result<W, Error>

Unwrap the underlying writer, finishing the compression stream.

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.

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.)

Trait Implementations

impl<W> Drop for XzDecoder<W> where
    W: Write, 

fn drop(&mut self)

Executes the destructor for this type.

impl<W> Read for XzDecoder<W> where
    W: Read + Write, 

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

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

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

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

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

Flush 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 Writeer 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 Self

Creates a "by reference" adaptor for this instance of Write.