Struct flate2::bufread::DeflateEncoder[][src]

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

A DEFLATE encoder, or compressor.

This structure consumes a BufRead interface, reading uncompressed data from the underlying reader, and emitting compressed data.

Examples

use std::io::prelude::*;
use std::io;
use flate2::Compression;
use flate2::bufread::DeflateEncoder;
use std::fs::File;
use std::io::BufReader;

// Opens sample file, compresses the contents and returns a Vector
fn open_hello_world() -> io::Result<Vec<u8>> {
   let f = File::open("examples/hello_world.txt")?;
   let b = BufReader::new(f);
   let mut deflater = DeflateEncoder::new(b, Compression::fast());
   let mut buffer = Vec::new();
   deflater.read_to_end(&mut buffer)?;
   Ok(buffer)
}

Implementations

impl<R: BufRead> DeflateEncoder<R>[src]

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

Notable traits for DeflateEncoder<R>

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

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

impl<R> DeflateEncoder<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.

pub fn get_ref(&self) -> &R[src]

Acquires a reference to the underlying reader

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.

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 DeflateEncoder<R>[src]

impl<R: BufRead> Read for DeflateEncoder<R>[src]

impl<W: BufRead + Write> Write for DeflateEncoder<W>[src]

Auto Trait Implementations

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

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

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

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

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