Struct gif::Decoder

pub struct Decoder<R: Read> {
    decoder: ReadDecoder<R>,
    pixel_converter: PixelConverter,
    bg_color: Option<u8>,
    repeat: Repeat,
    current_frame: Frame<'static>,
    current_frame_data_type: FrameDataType,
}

GIF decoder. Create DecodeOptions to get started, and call DecodeOptions::read_info.

Fields

decoder: ReadDecoder<R>

pixel_converter: PixelConverter

bg_color: Option<u8>

repeat: Repeat

current_frame: Frame<'static>

current_frame_data_type: FrameDataType

Implementations

impl<R> Decoder<R>

where R: Read,

pub fn new(reader: R) -> Result<Self, DecodingError>

Create a new decoder with default options.

pub fn build() -> DecodeOptions

Return a builder that allows configuring limits etc.

fn with_no_init( reader: R, decoder: StreamingDecoder, options: DecodeOptions, ) -> Decoder<R>

fn init(self) -> Result<Self, DecodingError>

pub fn next_frame_info( &mut self, ) -> Result<Option<&Frame<'static>>, DecodingError>

Returns the next frame info

pub fn read_next_frame( &mut self, ) -> Result<Option<&Frame<'static>>, DecodingError>

Reads the next frame from the image.

Do not call Self::next_frame_info beforehand. Deinterlaces the result.

You can also call .into_iter() on the decoder to use it as a regular iterator.

fn take_current_frame(&mut self) -> Option<Frame<'static>>

This is private for iterator’s use

pub fn read_into_buffer(&mut self, buf: &mut [u8]) -> Result<(), DecodingError>

Reads the data of the current frame into a pre-allocated buffer.

Self::next_frame_info needs to be called beforehand. The length of buf must be at least Self::buffer_size. Deinterlaces the result.

fn copy_lzw_into_buffer( &mut self, min_code_size: u8, buf: &mut Vec<u8>, ) -> Result<(), DecodingError>

pub fn fill_buffer(&mut self, buf: &mut [u8]) -> Result<bool, DecodingError>

Reads data of the current frame into a pre-allocated buffer until the buffer has been filled completely.

The buffer length must be an even number of pixels (multiple of 4 if decoding RGBA).

Self::next_frame_info needs to be called beforehand. Returns true if the supplied buffer could be filled completely. Should not be called after false had been returned.

pub fn buffer_size(&self) -> usize

Output buffer size

pub fn line_length(&self) -> usize

Line length of the current frame

pub fn palette(&self) -> Result<&[u8], DecodingError>

Returns the color palette relevant for the frame that has been decoded

pub fn global_palette(&self) -> Option<&[u8]>

The global color palette

pub fn width(&self) -> u16

Width of the image

pub fn height(&self) -> u16

Height of the image

pub fn into_inner(self) -> BufReader<R>

Abort decoding and recover the io::Read instance

pub fn bg_color(&self) -> Option<usize>

Index of the background color in the global palette

In practice this is not used, and the background is always transparent

pub fn repeat(&self) -> Repeat

Number of loop repetitions

Trait Implementations

impl<R: Read> IntoIterator for Decoder<R>

type Item = Result<Frame<'static>, DecodingError>

The type of the elements being iterated over.

type IntoIter = DecoderIter<R>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.