Struct StreamingDecoder 

pub struct StreamingDecoder;

A streaming GIF decoder that processes frames on-demand.

This decoder is more memory-efficient for large GIFs as it doesn’t need to hold all frames in memory simultaneously. However, it requires maintaining decoder state and is less suitable for random access.

Example

use figif_core::decoders::StreamingDecoder;
use figif_core::traits::GifDecoder;

let decoder = StreamingDecoder::new();
for frame in decoder.decode_file("large_animation.gif")? {
    let frame = frame?;
    // Process frame immediately
}

Implementations

impl StreamingDecoder

pub fn new() -> Self

Create a new streaming decoder.

Trait Implementations

impl Clone for StreamingDecoder

fn clone(&self) -> StreamingDecoder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamingDecoder

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

Formats the value using the given formatter.

impl Default for StreamingDecoder

fn default() -> StreamingDecoder

Returns the “default value” for a type.

impl GifDecoder for StreamingDecoder

type FrameIter = StreamingIterWrapper

The type of iterator returned by decode operations.

fn decode_file(&self, path: impl AsRef<Path>) -> Result<Self::FrameIter>

Decode a GIF from a file path.

fn decode_bytes(&self, data: &[u8]) -> Result<Self::FrameIter>

Decode a GIF from a byte slice.

fn decode_reader<R: Read + Send>(&self, reader: R) -> Result<Self::FrameIter>

Decode a GIF from any reader.

fn metadata_from_bytes(&self, data: &[u8]) -> Result<GifMetadata>

Extract metadata without fully decoding all frames.

fn metadata_from_file(&self, path: impl AsRef<Path>) -> Result<GifMetadata>

Extract metadata from a file.

fn name(&self) -> &'static str

Get the name of this decoder for logging/debugging.