Struct gif::Decoder[][src]

pub struct Decoder<R: Read> {
    decoder: ReadDecoder<R>,
    color_output: ColorOutput,
    memory_limit: MemoryLimit,
    bg_color: Option<u8>,
    global_palette: Option<Vec<u8>>,
    current_frame: Frame<'static>,
    buffer: Vec<u8>,
}

GIF decoder

Fields

decoder: ReadDecoder<R>color_output: ColorOutputmemory_limit: MemoryLimitbg_color: Option<u8>global_palette: Option<Vec<u8>>current_frame: Frame<'static>buffer: Vec<u8>

Implementations

impl<R> Decoder<R> where
    R: Read
[src]

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

Create a new decoder with default options.

pub fn build() -> DecodeOptions[src]

Return a builder that allows configuring limits etc.

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

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

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

Returns the next frame info

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

Reads the next frame from the image.

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

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

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.

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

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

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[src]

Output buffer size

pub fn line_length(&self) -> usize[src]

Line length of the current frame

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

Returns the color palette relevant for the current (next) frame

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

The global color palette

pub fn width(&self) -> u16[src]

Width of the image

pub fn height(&self) -> u16[src]

Height of the image

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

Index of the background color in the global palette

Auto Trait Implementations

impl<R> !RefUnwindSafe for Decoder<R>

impl<R> Send for Decoder<R> where
    R: Send

impl<R> !Sync for Decoder<R>

impl<R> Unpin for Decoder<R> where
    R: Unpin

impl<R> !UnwindSafe for Decoder<R>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.