Struct ImageFormat 

#[non_exhaustive]
pub struct ImageFormat {
    pub display_name: Txt,
    pub media_type_suffixes: Txt,
    pub file_extensions: Txt,
    pub magic_numbers: Txt,
    pub capabilities: ImageFormatCapability,
}

Represents an image codec capability.

This type will be used in the next breaking release of the view API.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

display_name: Txt

Display name of the format.

media_type_suffixes: Txt

Media types (MIME) associated with the format.

Lowercase, without "image/" prefix, comma separated if there is more than one.

file_extensions: Txt

Common file extensions associated with the format.

Lowercase, without dot, comma separated if there is more than one.

magic_numbers: Txt

Identifier file prefixes.

Lower case ASCII hexadecimals, comma separated if there is more than one, "xx" matches any byte.

capabilities: ImageFormatCapability

Capabilities of this format.

Implementations

impl ImageFormat

pub const fn from_static( display_name: &'static str, media_type_suffixes: &'static str, file_extensions: &'static str, capabilities: ImageFormatCapability, ) -> Self

👎Deprecated: use from_static2, it will replace this function next breaking release

From static str.

Panics

Panics if media_type_suffixes not ASCII.

pub const fn from_static2( display_name: &'static str, media_type_suffixes: &'static str, file_extensions: &'static str, magic_numbers: &'static str, capabilities: ImageFormatCapability, ) -> Self

From static strings.

Panics

Panics if media_type_suffixes or magic_numbers are not ASCII.

pub fn media_type_suffixes_iter(&self) -> impl Iterator<Item = &str>

Iterate over media type suffixes.

pub fn media_types(&self) -> impl Iterator<Item = Txt>

Iterate over full media types, with "image/" prefix.

pub fn file_extensions_iter(&self) -> impl Iterator<Item = &str>

Iterate over extensions.

pub fn matches(&self, f: &str) -> bool

Checks if f matches any of the mime types or any of the file extensions.

File extensions comparison ignores dot and ASCII case.

pub fn matches_magic(&self, file_prefix: &[u8]) -> bool

Check if file_prefix matches any magic numbers.

A good size for file_prefix is 24 bytes, it should cover all image formats.

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<'de> Deserialize<'de> for ImageFormat

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for ImageFormat

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ImageFormat

impl StructuralPartialEq for ImageFormat