Struct IncrementalDecoder 

pub struct IncrementalDecoder { /* private fields */ }

A push-based decoder for any still WebP or animation.

Dispatches on the container kind: lossless stills and all animations stream through [crate::lossless], a bare lossy VP8 still row-streams through [crate::lossy], and an extended lossy still (which may carry ALPH alpha) is buffered and finished with a one-shot decode. The pixels and error semantics match decode exactly; the only new streaming capability over the lossless/animation paths is the bare lossy still. Read-free, so it works on no_std + alloc.

Implementations

impl IncrementalDecoder

pub fn new() -> Self

A new decoder with default options.

pub const fn with_options(options: DecodeOptions) -> Self

A new decoder with the given options (output layout, per-image pixel limit).

pub fn push(&mut self, chunk: &[u8]) -> Result<Progress>

Feed the next slice of the file and report Progress.

Errors

The same errors as decode, surfaced as soon as the buffered bytes make them detectable.

pub fn frame_image(&self) -> Option<&Image>

The most-recently composited animation frame, or None for a still image. Mirrors the underlying decoder’s frame_image.

pub fn drain_rows(&mut self) -> Option<RowDrain<'_>>

Borrow the finalized-but-not-yet-viewed rows of a streamed still image (a non-consuming early view). None unless a row-streaming back end is active (a lossless or bare-lossy still); the deferred and animation paths yield no rows.

pub fn into_image(self) -> Result<Image>

Retrieve the complete decoded image (an animation’s first composited frame) once Progress::Finished has been reported.

Errors

The same errors as decode when the buffer is not a fully-decoded image.

Trait Implementations

impl Default for IncrementalDecoder

Available on crate feature alloc only.

fn default() -> Self

Returns the “default value” for a type.