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>

source

pub fn new(reader: R) -> DeflateDecoderBuf<R>

Create a new Deflatedecoderbuf to read from a raw deflate stream.

source

pub fn from_zlib(reader: R) -> DeflateDecoderBuf<R>

Create a new DeflateDecoderbuf that reads from a zlib wrapped deflate stream.

source

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>

source

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.

source

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.

source

pub fn get_ref(&self) -> &R

Returns a reference to the underlying BufRead instance.

source

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.

source

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.

source

pub fn total_in(&self) -> u64

Returns the total bytes read from the underlying BufRead instance.

source

pub fn total_out(&self) -> u64

Returns the total number of bytes output from this decoder.

source

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>

source§

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · source§

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more
source§

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Reader has an efficient read_vectored implementation. Read more
1.0.0 · source§

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf. Read more
1.0.0 · source§

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · source§

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf. Read more
source§

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Pull some bytes from this source into the specified buffer. Read more
source§

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)
Read the exact number of bytes required to fill cursor. Read more
1.0.0 · source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adaptor for this instance of Read. Read more
1.0.0 · source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · source§

fn chain<R>(self, next: R) -> Chain<Self, R>
where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more

Auto Trait Implementations§

§

impl<R> Freeze for DeflateDecoderBuf<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for DeflateDecoderBuf<R>
where R: RefUnwindSafe,

§

impl<R> Send for DeflateDecoderBuf<R>
where R: Send,

§

impl<R> Sync for DeflateDecoderBuf<R>
where R: Sync,

§

impl<R> Unpin for DeflateDecoderBuf<R>
where R: Unpin,

§

impl<R> UnwindSafe for DeflateDecoderBuf<R>
where R: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.