[][src]Struct xz::read::XzEncoder

pub struct XzEncoder<R> where
    R: Read
{ /* fields omitted */ }

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]

pub fn new(r: R, level: u32) -> XzEncoder<R>

Notable traits for XzEncoder<W>

impl<W> Write for XzEncoder<W> where
    W: Read + Write
impl<R> Read for XzEncoder<R> where
    R: Read
[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>

Notable traits for XzEncoder<W>

impl<W> Write for XzEncoder<W> where
    W: Read + Write
impl<R> Read for XzEncoder<R> where
    R: Read
[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]

impl<W> Write for XzEncoder<W> where
    W: Read + Write
[src]

Auto Trait Implementations

impl<R> RefUnwindSafe for XzEncoder<R> where
    R: RefUnwindSafe

impl<R> Send for XzEncoder<R> where
    R: Send

impl<R> Sync for XzEncoder<R> where
    R: Sync

impl<R> Unpin for XzEncoder<R> where
    R: Unpin

impl<R> UnwindSafe for XzEncoder<R> where
    R: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.