Skip to main content

DecodedImage

Enum DecodedImage 

Source
#[non_exhaustive]
pub enum DecodedImage { Png(PngDecoded), Jpeg(JpegDecoded), Bmp(BmpDecoded), }
Expand description

Universal decoded image — union of all per-codec decoded structs.

This enum is #[non_exhaustive] because new codecs (e.g. WebP) may be added over time. Users should include a wildcard arm when matching.

Each variant wraps the per-codec decoded struct (e.g. png::PngDecoded), which itself contains the pixel data and ancillary metadata. This means load() always gives you metadata for free — no separate “with metadata” function needed.

Per-codec pixel enums (e.g. png::PngImage) are not #[non_exhaustive] — they are exhaustive spec sheets. If you know the format, prefer decoding with the per-codec API directly; you get exhaustive matching and avoid the wildcard arm.

§Examples

let bytes = std::fs::read("image.png").unwrap();
match load(&bytes).unwrap() {
    #[cfg(feature = "png")]
    DecodedImage::Png(decoded) => {
        // `decoded.image` is a `PngImage` — match exhaustively
        // `decoded.metadata` carries colour-space info, text chunks, etc.
    }
    _ => { /* unknown or unsupported codec */ }
}

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Png(PngDecoded)

Available on crate feature png only.

A decoded PNG file — pixel data + metadata. Only available with the png feature.

§

Jpeg(JpegDecoded)

Available on crate feature jpeg only.

A decoded JPEG file — pixel data + metadata. Only available with the jpeg feature.

§

Bmp(BmpDecoded)

Available on crate feature bmp only.

A decoded BMP file — pixel data + metadata. Only available with the bmp feature.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> ConvertPixelExt for T

Source§

fn then<Mid, B>(self, next: B) -> Then<Self, B, Mid>

Chain this strategy with a second strategy, producing a Then combinator that converts Src → Mid → Dst in a single step. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromLinear<T> for T

Source§

fn from_linear(acc: T) -> T

Converts a linear-space accumulator value back to this pixel type, applying rounding and clamping. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.