pub struct DeflateDecoder<W: Write> { /* private fields */ }
Expand description
A DEFLATE decoder, or decompressor.
This structure implements a Write
and will emit a stream of decompressed
data when fed a stream of compressed data.
After decoding a single member of the DEFLATE data this writer will return the number of bytes up to to the end of the DEFLATE member and subsequent writes will return Ok(0) allowing the caller to handle any data following the DEFLATE member.
§Examples
use std::io::prelude::*;
use std::io;
use flate2::write::DeflateDecoder;
// Uncompresses a Deflate 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 deflater = DeflateDecoder::new(writer);
deflater.write_all(&bytes[..])?;
writer = deflater.finish()?;
let return_string = String::from_utf8(writer).expect("String parsing error");
Ok(return_string)
}
Implementations§
source§impl<W: Write> DeflateDecoder<W>
impl<W: Write> DeflateDecoder<W>
sourcepub fn new(w: W) -> DeflateDecoder<W> ⓘ
pub fn new(w: W) -> DeflateDecoder<W> ⓘ
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.
sourcepub fn get_mut(&mut self) -> &mut W
pub fn get_mut(&mut self) -> &mut W
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.
sourcepub fn reset(&mut self, w: W) -> Result<W>
pub fn reset(&mut self, w: W) -> Result<W>
Resets the state of this decoder entirely, swapping out the output stream for another.
This function will finish encoding the current stream into the current output stream before swapping out the two output streams.
This will then reset the internal state of this decoder and replace the
output stream with the one provided, returning the previous output
stream. Future data written to this decoder will be decompressed into
the output stream w
.
§Errors
This function will perform I/O to finish the stream, and if that I/O returns an error then that will be returned from this function.
sourcepub fn try_finish(&mut self) -> Result<()>
pub fn try_finish(&mut self) -> Result<()>
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.
sourcepub fn finish(self) -> Result<W>
pub fn finish(self) -> Result<W>
Consumes this encoder, 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§
source§impl<W: Read + Write> Read for DeflateDecoder<W>
impl<W: Read + Write> Read for DeflateDecoder<W>
source§fn read(&mut self, buf: &mut [u8]) -> Result<usize>
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
1.36.0 · source§fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
read
, except that it reads into a slice of buffers. Read moresource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)1.0.0 · source§fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
buf
. Read more1.0.0 · source§fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
buf
. Read more1.6.0 · source§fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf
. Read moresource§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)source§fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)cursor
. Read more1.0.0 · source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Read
. Read moresource§impl<W: Write> Write for DeflateDecoder<W>
impl<W: Write> Write for DeflateDecoder<W>
source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)1.0.0 · source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)