Struct xz2::read::XzEncoder
[−]
[src]
pub struct XzEncoder<R: Read> { /* fields omitted */ }
A compression stream which wraps an uncompressed stream of data. Compressed data will be read from the stream.
Methods
impl<R: Read> XzEncoder<R>
[src]
fn new(r: R, level: u32) -> XzEncoder<R>
Create a new compression stream which will compress at the given level to read compress output to the give output stream.
The level
argument here is typically 0-9 with 6 being a good default.
fn new_stream(r: R, stream: Stream) -> XzEncoder<R>
Creates a new encoder with a custom Stream
.
The Stream
can be pre-configured for multithreaded encoding, different
compression options/tuning, etc.
fn get_ref(&self) -> &R
Acquires a reference to the underlying stream
fn get_mut(&mut self) -> &mut R
Acquires a mutable reference to the underlying stream
Note that mutation of the stream may result in surprising results if this encoder is continued to be used.
fn into_inner(self) -> R
Unwrap the underlying writer, finishing the compression stream.
fn total_out(&self) -> u64
Returns the number of bytes produced by the compressor (e.g. the number of bytes read from this stream)
Note that, due to buffering, this only bears any relation to
total_in() when the compressor chooses to flush its data
(unfortunately, this won't happen this won't happen in general
at the end of the stream, because the compressor doesn't know
if there's more data to come). At that point,
total_out() / total_in()
would be the compression ratio.
fn total_in(&self) -> u64
Returns the number of bytes consumed by the compressor (e.g. the number of bytes read from the underlying stream)
Trait Implementations
impl<R: Read> Read for XzEncoder<R>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self>
1.0.0
Transforms this Read
instance to an Iterator
over its bytes. Read more
fn chars(self) -> Chars<Self>
🔬 This is a nightly-only experimental API. (io
)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an Iterator
over char
s. Read more
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0
R: Read,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self>
1.0.0
Creates an adaptor which will read at most limit
bytes from it. Read more
impl<W: Write + Read> Write for XzEncoder<W>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0
Creates a "by reference" adaptor for this instance of Write
. Read more