Struct Supplements 

#[non_exhaustive]
pub struct Supplements {
    pub pyramid: bool,
    pub gain_map: bool,
    pub depth_map: bool,
    pub segmentation_mattes: bool,
    pub auxiliary: bool,
}

Supplemental content that accompanies the primary image(s).

These are not independent viewable images — they modify or augment the primary content. Each supplement type implies a distinct access pattern and a future accessor trait.

Populated during probe. May be incomplete from probe() (cheap) and more complete from probe_full() (expensive).

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.

pyramid: bool

Reduced-resolution versions (image pyramid, thumbnails).

TIFF pyramids, HEIF thumbnails, JPEG JFIF thumbnails.

gain_map: bool

HDR gain map for SDR/HDR tone mapping.

JPEG Ultra HDR (ISO 21496-1), AVIF gain map, JXL gain map, HEIF gain map.

depth_map: bool

Depth map (portrait mode, 3D reconstruction).

HEIF depth maps, Google Camera depth in JPEG, AVIF depth auxiliary.

segmentation_mattes: bool

Segmentation mattes (portrait effects, hair, skin, teeth, glasses, sky).

iPhone HEIC files with portrait mode or semantic segmentation.

auxiliary: bool

Other auxiliary images not covered by named fields.

Alpha planes stored as separate images (HEIF), transparency masks (TIFF), vendor-specific auxiliary data.

Trait Implementations

impl Clone for Supplements

fn clone(&self) -> Supplements

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Supplements

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

Formats the value using the given formatter.

impl Default for Supplements

fn default() -> Supplements

Returns the “default value” for a type.

impl PartialEq for Supplements

fn eq(&self, other: &Supplements) -> 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 Eq for Supplements

impl StructuralPartialEq for Supplements