Struct flate2::write::GzEncoder[][src]

pub struct GzEncoder<W: Write> { /* fields omitted */ }

A gzip streaming encoder

This structure exposes a Write interface that will emit compressed data to the underlying writer W.

Examples

use std::io::prelude::*;
use flate2::Compression;
use flate2::write::GzEncoder;

// Vec<u8> implements Write to print the compressed bytes of sample string

let mut e = GzEncoder::new(Vec::new(), Compression::default());
e.write_all(b"Hello World").unwrap();
println!("{:?}", e.finish().unwrap());

Implementations

impl<W: Write> GzEncoder<W>[src]

pub fn new(w: W, level: Compression) -> GzEncoder<W>

Notable traits for GzEncoder<R>

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

Creates a new encoder which will use the given compression level.

The encoder is not configured specially for the emitted header. For header configuration, see the GzBuilder type.

The data written to the returned encoder will be compressed and then written to the stream w.

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 mutation of the writer may result in surprising results if this encoder is continued to be used.

pub fn try_finish(&mut self) -> Result<()>[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.

Errors

This function will perform I/O to complete this stream, and any I/O errors which occur will be returned from this function.

pub fn finish(self) -> Result<W>[src]

Finish encoding this stream, returning the underlying writer once the encoding is done.

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.

Errors

This function will perform I/O to complete this stream, and any I/O errors which occur will be returned from this function.

Trait Implementations

impl<W: Debug + Write> Debug for GzEncoder<W>[src]

impl<W: Write> Drop for GzEncoder<W>[src]

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

impl<W: Write> Write for GzEncoder<W>[src]

Auto Trait Implementations

impl<W> RefUnwindSafe for GzEncoder<W> where
    W: RefUnwindSafe

impl<W> Send for GzEncoder<W> where
    W: Send

impl<W> Sync for GzEncoder<W> where
    W: Sync

impl<W> Unpin for GzEncoder<W> where
    W: Unpin

impl<W> UnwindSafe for GzEncoder<W> where
    W: 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.