[−][src]Struct xz::write::XzEncoder
A compression stream which will have uncompressed data written to it and will write compressed data to an output stream.
Implementations
impl<W> XzEncoder<W> where
W: Write,
[src]
W: Write,
pub fn new(obj: W, level: u32) -> XzEncoder<W>ⓘ
[src]
Create a new compression stream which will compress at the given level to write compress output to the give output stream.
pub fn new_stream(obj: W, stream: Stream) -> XzEncoder<W>ⓘ
[src]
Create a new encoder which will use the specified Stream
to encode
(compress) data into the provided obj
.
pub fn get_ref(&self) -> &W
[src]
Acquires a reference to the underlying writer.
pub fn get_mut(&mut self) -> &mut W
[src]
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 try_finish(&mut self) -> Result<(), Error>
[src]
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.
pub fn finish(self) -> Result<W, Error>
[src]
Consumes this encoder, flushing the output stream.
This will flush the underlying data stream and then return the contained writer if the flush succeeded.
Note that this function may not be suitable to call in a situation where
the underlying stream is an asynchronous I/O stream. To finish a stream
the try_finish
(or shutdown
) method should be used instead. To
re-acquire ownership of a stream it is safe to call this method after
try_finish
or shutdown
has returned Ok
.
pub fn total_out(&self) -> u64
[src]
Returns the number of bytes produced by the compressor
Note that, due to buffering, this only bears any relation to
total_in()
after a call to flush()
. At that point,
total_out() / total_in()
is 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 written to this stream.)
Trait Implementations
impl<W> Drop for XzEncoder<W> where
W: Write,
[src]
W: Write,
impl<W> Read for XzEncoder<W> where
W: Read + Write,
[src]
W: Read + Write,
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: Write,
[src]
W: Write,
fn write(&mut self, data: &[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<W> RefUnwindSafe for XzEncoder<W> where
W: RefUnwindSafe,
W: RefUnwindSafe,
impl<W> Send for XzEncoder<W> where
W: Send,
W: Send,
impl<W> Sync for XzEncoder<W> where
W: Sync,
W: Sync,
impl<W> Unpin for XzEncoder<W> where
W: Unpin,
W: Unpin,
impl<W> UnwindSafe for XzEncoder<W> where
W: UnwindSafe,
W: 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>,