Struct image::gif::Decoder

pub struct Decoder<R: Read> { /* fields omitted */ }

GIF decoder

Methods

impl<R: Read> Decoder<R>

pub fn new(r: R) -> ImageResult<Decoder<R>>

Creates a new decoder that decodes the input steam r

Trait Implementations

impl<'a, R: 'a + Read> ImageDecoder<'a> for Decoder<R>

type Reader = GifReader<R>

The type of reader produced by into_reader.

fn dimensions(&self) -> (u64, u64)

Returns a tuple containing the width and height of the image

fn colortype(&self) -> ColorType

Returns the color type of the image e.g. RGB(8) (8bit RGB)

fn into_reader(self) -> ImageResult<Self::Reader>

Returns a reader that can be used to obtain the bytes of the image. For the best performance, always try to read at least scanline_bytes from the reader at a time. Reading fewer bytes will cause the reader to perform internal buffering.

fn read_image(self) -> ImageResult<Vec<u8>>

Returns all the bytes in the image.

fn row_bytes(&self) -> u64

Returns the number of bytes in a single row of the image. All decoders will pad image rows to a byte boundary.

fn total_bytes(&self) -> u64

Returns the total number of bytes in the image.

fn scanline_bytes(&self) -> u64

Returns the minimum number of bytes that can be efficiently read from this decoder. This may be as few as 1 or as many as total_bytes().

fn read_image_with_progress<F: Fn(Progress)>(
    self,
    progress_callback: F
) -> ImageResult<Vec<u8>>

Same as read_image but periodically calls the provided callback to give updates on loading progress.

impl<'a, R: Read + 'a> AnimationDecoder<'a> for Decoder<R>

Important traits for Frames<'a>

impl<'a> Iterator for Frames<'a> type Item = ImageResult<Frame>;

fn into_frames(self) -> Frames<'a>

Consume the decoder producing a series of frames.