Skip to main content

ImageData

Enum ImageData 

Source
#[non_exhaustive]
pub enum ImageData<'a> { Borrowed(&'a [u8]), BorrowedColors(&'a [Color]), Owned(Vec<u8>), Asset(AssetHandle), }
Expand description

Pixel storage owned by or borrowed by an ImageDescriptor.

The enum is non-exhaustive so future asset-handle sources can be added without breaking callers. Consumers should include a wildcard arm when matching.

§LPAR-09 addition

The ImageData::Asset variant bridges source-backed images (registered with an AssetRegistry) into the image pipeline. Decoded pixels may or may not be resident in the cache; callers MUST call AssetRegistry::resolve_image before blitting to ensure decoded data is present.

§Match exhaustiveness

Because ImageData is #[non_exhaustive], external match expressions already require a wildcard arm. The addition of Asset is non-breaking.

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.
§

Borrowed(&'a [u8])

Borrowed encoded pixel bytes in the descriptor’s PixelFormat.

§

BorrowedColors(&'a [Color])

Borrowed Color pixels used as a safe zero-copy ARGB8888 bridge.

This avoids casting Color values to raw bytes; consumers that need packed bytes can serialize each color with Color::to_argb8888.

§

Owned(Vec<u8>)

Heap-resident encoded pixel bytes in the descriptor’s PixelFormat.

§

Asset(AssetHandle)

Available on crate feature fs only.

Source-backed image handle registered with an AssetRegistry.

The decoded pixels may or may not be resident in the SlotCache at any moment. Callers MUST call AssetRegistry::resolve_image(handle) to obtain a descriptor with in-memory pixel data before blitting.

Added by LPAR-09 (Standards Action; LPAR-08 §15 amendment filed 2026-06-12). Ownership of the AssetPath behind this handle lives in the AssetRegistry, enabling reload after cache eviction.

Implementations§

Source§

impl<'a> ImageData<'a>

Source

pub fn byte_len(&self) -> usize

Return the encoded byte length represented by this data source.

ImageData::BorrowedColors reports colors.len() * 4 because each color is represented as one ARGB8888 pixel.

ImageData::Asset returns 0 because decoded pixels are not in-memory until AssetRegistry::resolve_image is called. This follows LVGL’s model where an unresolved source has zero in-memory size.

Source

pub fn is_empty(&self) -> bool

Return true when this data source contains no pixels.

Source

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

Return borrowed encoded bytes when this source is byte-addressable.

ImageData::BorrowedColors and ImageData::Asset return None because neither exposes in-memory bytes directly.

Source

pub fn as_color_slice(&self) -> Option<&[Color]>

Return borrowed color pixels when this source is the safe color bridge.

Trait Implementations§

Source§

impl<'a> Clone for ImageData<'a>

Source§

fn clone(&self) -> ImageData<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for ImageData<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for ImageData<'a>

Source§

impl<'a> PartialEq for ImageData<'a>

Source§

fn eq(&self, other: &ImageData<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for ImageData<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for ImageData<'a>

§

impl<'a> RefUnwindSafe for ImageData<'a>

§

impl<'a> Send for ImageData<'a>

§

impl<'a> Sync for ImageData<'a>

§

impl<'a> Unpin for ImageData<'a>

§

impl<'a> UnsafeUnpin for ImageData<'a>

§

impl<'a> UnwindSafe for ImageData<'a>

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> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.