Struct flate2::read::DeflateDecoder [−][src]
A DEFLATE decoder, or decompressor.
This structure implements a Read
interface and takes a stream of
compressed data as input, providing the decompressed data when read from.
Examples
use std::io::prelude::*; use std::io; use flate2::read::DeflateDecoder; // Uncompresses a Deflate Encoded vector of bytes and returns a string or error // Here &[u8] implements Read fn decode_reader(bytes: Vec<u8>) -> io::Result<String> { let mut deflater = DeflateDecoder::new(&bytes[..]); let mut s = String::new(); deflater.read_to_string(&mut s)?; Ok(s) }
Implementations
impl<R: Read> DeflateDecoder<R>
[src]
pub fn new(r: R) -> DeflateDecoder<R>ⓘNotable traits for DeflateDecoder<R>
impl<R: Read> Read for DeflateDecoder<R>impl<W: Read + Write> Write for DeflateDecoder<W>
[src]
Notable traits for DeflateDecoder<R>
impl<R: Read> Read for DeflateDecoder<R>impl<W: Read + Write> Write for DeflateDecoder<W>
Creates a new decoder which will decompress data read from the given stream.
pub fn new_with_buf(r: R, buf: Vec<u8>) -> DeflateDecoder<R>ⓘNotable traits for DeflateDecoder<R>
impl<R: Read> Read for DeflateDecoder<R>impl<W: Read + Write> Write for DeflateDecoder<W>
[src]
Notable traits for DeflateDecoder<R>
impl<R: Read> Read for DeflateDecoder<R>impl<W: Read + Write> Write for DeflateDecoder<W>
Same as new
, but the intermediate buffer for data is specified.
Note that the capacity of the intermediate buffer is never increased, and it is recommended for it to be large.
impl<R> DeflateDecoder<R>
[src]
pub fn reset(&mut self, r: R) -> R
[src]
Resets the state of this decoder entirely, swapping out the input stream for another.
This will reset the internal state of this decoder and replace the
input stream with the one provided, returning the previous input
stream. Future data read from this decoder will be the decompressed
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 decoder, 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 the decompressor has consumed.
Note that this will likely be smaller than what the decompressor actually read from the underlying stream due to buffering.
pub fn total_out(&self) -> u64
[src]
Returns the number of bytes that the decompressor has produced.
Trait Implementations
impl<R: Debug> Debug for DeflateDecoder<R>
[src]
impl<R: Read> Read for DeflateDecoder<R>
[src]
fn read(&mut self, into: &mut [u8]) -> Result<usize>
[src]
pub fn read_vectored(
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
1.36.0[src]
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
pub fn is_read_vectored(&self) -> bool
[src]
pub unsafe fn initializer(&self) -> Initializer
[src]
pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]
pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
pub fn by_ref(&mut self) -> &mut Self
1.0.0[src]
pub fn bytes(self) -> Bytes<Self>
1.0.0[src]
pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
pub fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
impl<W: Read + Write> Write for DeflateDecoder<W>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn flush(&mut self) -> Result<()>
[src]
pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>
1.36.0[src]
pub fn is_write_vectored(&self) -> bool
[src]
pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
pub fn write_all_vectored(
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
[src]
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>
1.0.0[src]
pub fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Auto Trait Implementations
impl<R> RefUnwindSafe for DeflateDecoder<R> where
R: RefUnwindSafe,
R: RefUnwindSafe,
impl<R> Send for DeflateDecoder<R> where
R: Send,
R: Send,
impl<R> Sync for DeflateDecoder<R> where
R: Sync,
R: Sync,
impl<R> Unpin for DeflateDecoder<R> where
R: Unpin,
R: Unpin,
impl<R> UnwindSafe for DeflateDecoder<R> where
R: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,