Struct AvifDecoder 

pub struct AvifDecoder { /* private fields */ }

Decodes an AVIF stream.

Implementations

impl AvifDecoder

pub fn new<S>(source: S, limits: Limits) -> Result<AvifDecoder, PixelsError>

where S: Source,

Read the container and describe the primary image.

Decodes no pixels: this parses boxes only, which is what makes metadata() free.

Errors

Returns PixelsError::Malformed for a stream that is not a structurally valid AVIF, PixelsError::Unsupported for a valid file using a feature this decoder does not implement, or PixelsError::LimitExceeded if the image exceeds limits.

pub const fn info(&self) -> &AvifInfo

What the container said about this image.

Trait Implementations

impl Debug for AvifDecoder

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

Formats the value using the given formatter.

impl Decoder for AvifDecoder

fn descriptor(&self) -> ImageDescriptor

The shape of the image, known after the header is parsed.

fn orientation(&self) -> Orientation

How the stored image must be turned to display upright, as its metadata declares.

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

The embedded ICC colour profile, if the file carries one.

fn capability(&self) -> DecodeCapability

What this decoder can produce without a full decode.

fn read_row(&mut self, out: &mut [u8]) -> Result<(), PixelsError>

Decode the next row, top to bottom, into out.

fn animation(&self) -> Option<Animation>

The source’s animation, if it has more than one frame.

fn read_region( &mut self, region: Region, out: &mut TileMut<'_>, ) -> Result<(), PixelsError>

Decode an arbitrary region into out.

fn reduced_descriptor(&self, target: (u32, u32)) -> Option<ImageDescriptor>

What this decoder would produce if asked for target or larger, when the format lets it reach that size more cheaply than a full decode.

fn reduce_to(&mut self, descriptor: ImageDescriptor) -> Result<(), PixelsError>

Commit to producing descriptor, which Decoder::reduced_descriptor must have returned.