Struct HeatshrinkDecoder 

pub struct HeatshrinkDecoder<const W: usize, const L: usize, const I: usize, const WIN: usize> { /* private fields */ }

Heatshrink decoder.

Type parameters

• W : base-2 log of the LZSS sliding window size (must match the encoder).
• L : number of bits for back-reference lengths (must match the encoder).
• I : streaming input buffer size in bytes (>= 1, tunable for RAM/throughput).
• WIN : output (window) buffer size in bytes; must equal 1 << W. (Redundant parameter required because Rust stable does not yet support arithmetic on const generics in array sizes.)

Use DefaultDecoder or the dispatch helpers in heatshrink-bin rather than setting WIN manually.

Panics

new() panics if: W < 4, L < 3, L >= W, W > 14, I < 1, or WIN != 1 << W.

Implementations

impl<const W: usize, const L: usize, const I: usize, const WIN: usize> HeatshrinkDecoder<W, L, I, WIN>

pub fn new() -> Self

Create a new decoder instance.

Panics

Panics if W < 4, L < 3, L >= W, W > 15, I < 1, or WIN != 1 << W.

pub fn reset(&mut self)

Reset the decoder to its initial state so it can be reused.

pub fn sink(&mut self, input_buffer: &[u8]) -> Result<usize, SinkError>

Feed compressed data into the decoder.

pub fn poll(&mut self, output_buffer: &mut [u8]) -> Result<Poll, PollError>

Pull decompressed output out of the decoder into output_buffer.

pub fn finish(&self) -> Finish

Signal end of input.

Trait Implementations

impl<const W: usize, const L: usize, const I: usize, const WIN: usize> Debug for HeatshrinkDecoder<W, L, I, WIN>

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

Formats the value using the given formatter.

impl<const W: usize, const L: usize, const I: usize, const WIN: usize> Default for HeatshrinkDecoder<W, L, I, WIN>

fn default() -> Self

Returns the “default value” for a type.