Struct flate2::write::GzDecoder[][src]

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

A gzip streaming decoder

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

Examples

use std::io::prelude::*;
use std::io;
use flate2::Compression;
use flate2::write::{GzEncoder, GzDecoder};

// Uncompresses a gzip encoded vector of bytes and returns a string or error
// Here Vec<u8> implements Write
fn decode_writer(bytes: Vec<u8>) -> io::Result<String> {
   let mut writer = Vec::new();
   let mut decoder = GzDecoder::new(writer);
   decoder.write_all(&bytes[..])?;
   writer = decoder.finish()?;
   let return_string = String::from_utf8(writer).expect("String parsing error");
   Ok(return_string)
}

Implementations

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

pub fn new(w: W) -> GzDecoder<W>

Notable traits for GzDecoder<W>

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

Creates a new decoder which will write uncompressed data to the stream.

When this encoder is dropped or unwrapped the final pieces of data will be flushed.

pub fn header(&self) -> Option<&GzHeader>[src]

Returns the header associated with this stream.

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<()>[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 finish the stream, returning any errors which happen.

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

Consumes this decoder, 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.

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 GzDecoder<W>[src]

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

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

Auto Trait Implementations

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

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

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

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

impl<W> UnwindSafe for GzDecoder<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.