Struct Inflater 

pub struct Inflater { /* private fields */ }

An incremental DEFLATE decompressor.

Feed bytes with Inflater::feed, drain output with Inflater::take_output, and call Inflater::end_of_input when the stream is over. Output beyond the configured limit is a malformed-input error, never an allocation.

Implementations

impl Inflater

pub fn new(limit: usize) -> Self

A decompressor that will produce at most limit bytes.

pub fn feed(&mut self, data: &[u8])

Supply more compressed bytes.

pub const fn end_of_input(&mut self)

Declare that no further compressed bytes will arrive.

pub const fn is_finished(&self) -> bool

Whether the final block has been decoded.

pub const fn produced(&self) -> usize

How many bytes have been produced in total.

pub fn retained(&self) -> usize

How many output bytes are currently held — history plus undrained.

Exposed so callers can assert the streaming guarantee rather than trust it: a drained inflater retains the 32 KiB window and no more.

pub fn take_output(&mut self) -> Vec<u8>

Take everything decoded since the last call.

Draining is what bounds memory: the decompressor keeps only the 32 KiB of history that back-references can still reach, so a caller that drains regularly holds a fixed amount regardless of stream length.

pub fn decode(&mut self) -> Result<()>

Decode as far as the buffered input allows.

Errors

Returns Error for an invalid stream, for output exceeding the limit, or for a stream that ended mid-symbol after Inflater::end_of_input.

Trait Implementations

impl Debug for Inflater

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.