[−][src]Struct xz::read::XzEncoder
A compression stream which wraps an uncompressed stream of data. Compressed data will be read from the stream.
Implementations
impl<R> XzEncoder<R> where
R: Read,
[src]
R: Read,
pub fn new(r: R, level: u32) -> XzEncoder<R>ⓘ
[src]
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.
pub fn new_stream(r: R, stream: Stream) -> XzEncoder<R>ⓘ
[src]
Creates a new encoder with a custom Stream
.
The Stream
can be pre-configured for multithreaded encoding, different
compression options/tuning, etc.
pub fn get_ref(&self) -> &R
[src]
Acquires a reference to the underlying stream
pub fn get_mut(&mut self) -> &mut R
[src]
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.
pub fn into_inner(self) -> R
[src]
Unwrap the underlying writer, finishing the compression stream.
pub fn total_out(&self) -> u64
[src]
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.
pub fn total_in(&self) -> u64
[src]
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 for XzEncoder<R> where
R: Read,
[src]
R: Read,
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
1.36.0[src]
fn is_read_vectored(&self) -> bool
[src]
unsafe fn initializer(&self) -> Initializer
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn bytes(self) -> Bytes<Self>
1.0.0[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
impl<W> Write for XzEncoder<W> where
W: Read + Write,
[src]
W: Read + Write,
fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
fn flush(&mut self) -> Result<(), Error>
[src]
fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>
1.36.0[src]
fn is_write_vectored(&self) -> bool
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
[src]
fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Auto Trait Implementations
impl<R> RefUnwindSafe for XzEncoder<R> where
R: RefUnwindSafe,
R: RefUnwindSafe,
impl<R> Send for XzEncoder<R> where
R: Send,
R: Send,
impl<R> Sync for XzEncoder<R> where
R: Sync,
R: Sync,
impl<R> Unpin for XzEncoder<R> where
R: Unpin,
R: Unpin,
impl<R> UnwindSafe for XzEncoder<R> where
R: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,