Enum ImageFormat 

#[non_exhaustive]
pub enum ImageFormat {
    Jpeg,
    Png,
    Gif,
    WebP,
    Avif,
    Jxl,
    Heic,
    Bmp,
    Tiff,
    Ico,
    Pnm,
    Farbfeld,
    Qoi,
    Unknown,
    Custom(&'static ImageFormatDefinition),
}

Supported image formats.

Includes well-known formats as named variants and a Custom variant for formats defined by downstream crates.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Jpeg

Png

Gif

WebP

Avif

Jxl

Heic

Bmp

Tiff

Ico

Pnm

Farbfeld

Qoi

Unknown

Custom(&'static ImageFormatDefinition)

Format not known to zencodec.

Define an ImageFormatDefinition as a static and reference it here. The definition carries its own metadata (extensions, MIME types, detection function, capability flags).

Implementations

impl ImageFormat

pub const RECOMMENDED_PROBE_BYTES: usize = 4096

Recommended bytes to fetch for probing any format.

4096 bytes is enough for all built-in formats including JPEG (which may have large EXIF/APP segments before the SOF marker).

pub fn definition(self) -> Option<&'static ImageFormatDefinition>

The ImageFormatDefinition for this format, if known.

Returns None only for Unknown. All built-in variants and Custom formats have definitions.

pub fn mime_type(self) -> &'static str

Primary MIME type string.

pub fn mime_types(self) -> &'static [&'static str]

All recognized MIME types for this format.

pub fn extension(self) -> &'static str

Primary file extension (without dot).

pub fn extensions(self) -> &'static [&'static str]

All recognized file extensions.

pub fn supports_lossy(self) -> bool

Whether this format supports lossy encoding.

pub fn supports_lossless(self) -> bool

Whether this format supports lossless encoding.

pub fn supports_animation(self) -> bool

Whether this format supports animation.

pub fn supports_alpha(self) -> bool

Whether this format supports alpha channel.

pub fn magic_bytes_needed(self) -> usize

Recommended bytes to fetch for reliable format probing.

Trait Implementations

impl Clone for ImageFormat

fn clone(&self) -> ImageFormat

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImageFormat

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

Formats the value using the given formatter.

impl Display for ImageFormat

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

Formats the value using the given formatter.

impl Hash for ImageFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ImageFormat

fn eq(&self, other: &ImageFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ImageFormat

impl Eq for ImageFormat

impl StructuralPartialEq for ImageFormat