Struct flate2::read::ZlibEncoder[][src]

pub struct ZlibEncoder<R> { /* fields omitted */ }

A ZLIB encoder, or compressor.

This structure implements a Read interface and will read uncompressed data from an underlying stream and emit a stream of compressed data.

Examples

use std::io::prelude::*;
use flate2::Compression;
use flate2::read::ZlibEncoder;
use std::fs::File;

// Open example file and compress the contents using Read interface

let f = File::open("examples/hello_world.txt")?;
let mut z = ZlibEncoder::new(f, Compression::fast());
let mut buffer = [0;50];
let byte_count = z.read(&mut buffer)?;

Implementations

impl<R: Read> ZlibEncoder<R>[src]

pub fn new(r: R, level: Compression) -> ZlibEncoder<R>

Notable traits for ZlibEncoder<R>

impl<R: Read> Read for ZlibEncoder<R>impl<W: Read + Write> Write for ZlibEncoder<W>
[src]

Creates a new encoder which will read uncompressed data from the given stream and emit the compressed stream.

impl<R> ZlibEncoder<R>[src]

pub fn reset(&mut self, r: R) -> R[src]

Resets the state of this encoder entirely, swapping out the input stream for another.

This function will reset the internal state of this encoder and replace the input stream with the one provided, returning the previous input stream. Future data read from this encoder will be the compressed version of r’s data.

Note that there may be currently buffered data when this function is called, and in that case the buffered data is discarded.

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]

Consumes this encoder, returning the underlying reader.

Note that there may be buffered bytes which are not re-acquired as part of this transition. It’s recommended to only call this function after EOF has been reached.

pub fn total_in(&self) -> u64[src]

Returns the number of bytes that have been read into this compressor.

Note that not all bytes read from the underlying object may be accounted for, there may still be some active buffering.

pub fn total_out(&self) -> u64[src]

Returns the number of bytes that the compressor has produced.

Note that not all bytes may have been read yet, some may still be buffered.

Trait Implementations

impl<R: Debug> Debug for ZlibEncoder<R>[src]

impl<R: Read> Read for ZlibEncoder<R>[src]

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

Auto Trait Implementations

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

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

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

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

impl<R> UnwindSafe for ZlibEncoder<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.