Struct gif::Decoder[−][src]

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

Expand description

GIF decoder

Implementations

[src]

impl<R> Decoder<R> where
R: Read,

[src]

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

Create a new decoder with default options.

[src]

pub fn build() -> DecodeOptions

Return a builder that allows configuring limits etc.

[src]

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

Returns the next frame info

[src]

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.

[src]

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.

[src]

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.

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.

[src]

pub fn buffer_size(&self) -> usize

Output buffer size

[src]

pub fn line_length(&self) -> usize

Line length of the current frame

[src]

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

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

[src]

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

The global color palette

[src]

pub fn width(&self) -> u16

Width of the image

[src]

pub fn height(&self) -> u16

Height of the image

[src]

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

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

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct gif::Decoder[−][src]

Implementations

impl<R> Decoder<R> where
R: Read,

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

pub fn build() -> DecodeOptions

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

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

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

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

pub fn buffer_size(&self) -> usize

pub fn line_length(&self) -> usize

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

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

pub fn width(&self) -> u16

pub fn height(&self) -> u16

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

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,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct gif::Decoder[−][src]

Implementations

impl<R> Decoder<R> where R: Read,

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

pub fn build() -> DecodeOptions

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

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

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

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

pub fn buffer_size(&self) -> usize

pub fn line_length(&self) -> usize

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

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

pub fn width(&self) -> u16

pub fn height(&self) -> u16

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

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,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<R> Decoder<R> where
R: Read,

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,