Struct inflate::DeflateDecoderBuf
source · pub struct DeflateDecoderBuf<R> { /* private fields */ }
Expand description
A DEFLATE decoder/decompressor.
This structure implements a Read
interface and takes a stream
of compressed data that implements the BufRead
trait as input,
providing the decompressed data when read from.
§Example
use std::io::Read;
use inflate::DeflateDecoderBuf;
const TEST_STRING: &'static str = "Hello, world";
let encoded = vec![243, 72, 205, 201, 201, 215, 81, 40, 207, 47, 202, 73, 1, 0];
let mut decoder = DeflateDecoderBuf::new(&encoded[..]);
let mut output = Vec::new();
let status = decoder.read_to_end(&mut output);
assert_eq!(String::from_utf8(output).unwrap(), TEST_STRING);
Implementations§
source§impl<R: BufRead> DeflateDecoderBuf<R>
impl<R: BufRead> DeflateDecoderBuf<R>
sourcepub fn new(reader: R) -> DeflateDecoderBuf<R> ⓘ
pub fn new(reader: R) -> DeflateDecoderBuf<R> ⓘ
Create a new Deflatedecoderbuf
to read from a raw deflate stream.
sourcepub fn from_zlib(reader: R) -> DeflateDecoderBuf<R> ⓘ
pub fn from_zlib(reader: R) -> DeflateDecoderBuf<R> ⓘ
Create a new DeflateDecoderbuf
that reads from a zlib wrapped deflate stream.
sourcepub fn from_zlib_no_checksum(reader: R) -> DeflateDecoderBuf<R> ⓘ
pub fn from_zlib_no_checksum(reader: R) -> DeflateDecoderBuf<R> ⓘ
Create a new DeflateDecoderbuf
that reads from a zlib wrapped deflate stream.
without calculating and validating the checksum.
source§impl<R> DeflateDecoderBuf<R>
impl<R> DeflateDecoderBuf<R>
sourcepub fn reset(&mut self, r: R) -> R
pub fn reset(&mut self, r: R) -> R
Resets the decompressor, and replaces the current inner BufRead
instance by r
.
without doing any extra reallocations.
Note that this function doesn’t ensure that all data has been output.
sourcepub fn reset_data(&mut self)
pub fn reset_data(&mut self)
Resets the decoder, but continue to read from the same reader.
Note that this function doesn’t ensure that all data has been output.
sourcepub fn get_mut(&mut self) -> &mut R
pub fn get_mut(&mut self) -> &mut R
Returns a mutable reference to the underlying BufRead
instance.
Note that mutation of the reader may cause surprising results if the decoder is going to keep being used.
sourcepub fn into_inner(self) -> R
pub fn into_inner(self) -> R
Drops the decoder and return the inner BufRead
instance.
Note that this function doesn’t ensure that all data has been output.
sourcepub fn total_in(&self) -> u64
pub fn total_in(&self) -> u64
Returns the total bytes read from the underlying BufRead
instance.
sourcepub fn current_checksum(&self) -> u32
pub fn current_checksum(&self) -> u32
Returns the calculated checksum value of the currently decoded data.
Will return 0 for cases where the checksum is not validated.
Trait Implementations§
source§impl<R: BufRead> Read for DeflateDecoderBuf<R>
impl<R: BufRead> Read for DeflateDecoderBuf<R>
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 more