Struct Metadata 

#[non_exhaustive]
pub struct Metadata {
    pub icc_profile: Option<Arc<[u8]>>,
    pub exif: Option<Arc<[u8]>>,
    pub xmp: Option<Arc<[u8]>>,
    pub cicp: Option<Cicp>,
    pub content_light_level: Option<ContentLightLevel>,
    pub mastering_display: Option<MasteringDisplay>,
    pub orientation: Orientation,
}

Owned image metadata for encode/decode roundtrip.

Byte buffers (ICC, EXIF, XMP) use Arc<[u8]> so cloning is a cheap ref-count bump. Construct via Metadata::none() + builders, or extract from decoded info via From<&ImageInfo>.

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.

icc_profile: Option<Arc<[u8]>>

ICC color profile.

exif: Option<Arc<[u8]>>

EXIF metadata.

xmp: Option<Arc<[u8]>>

XMP metadata.

cicp: Option<Cicp>

CICP color description.

content_light_level: Option<ContentLightLevel>

Content Light Level Info for HDR content.

mastering_display: Option<MasteringDisplay>

Mastering Display Color Volume for HDR content.

orientation: Orientation

EXIF orientation.

Implementations

impl Metadata

pub fn none() -> Self

Create empty metadata.

pub fn with_icc(self, icc: impl Into<Arc<[u8]>>) -> Self

Set the ICC color profile.

Accepts Vec<u8>, &[u8], or Arc<[u8]>.

pub fn with_exif(self, exif: impl Into<Arc<[u8]>>) -> Self

Set the EXIF metadata.

Accepts Vec<u8>, &[u8], or Arc<[u8]>.

pub fn with_xmp(self, xmp: impl Into<Arc<[u8]>>) -> Self

Set the XMP metadata.

Accepts Vec<u8>, &[u8], or Arc<[u8]>.

pub fn with_cicp(self, cicp: Cicp) -> Self

Set the CICP color description.

pub fn with_content_light_level(self, clli: ContentLightLevel) -> Self

Set the Content Light Level Info.

pub fn with_mastering_display(self, mdcv: MasteringDisplay) -> Self

Set the Mastering Display Color Volume.

pub fn with_orientation(self, orientation: Orientation) -> Self

Set the EXIF orientation.

pub fn is_empty(&self) -> bool

Whether any metadata is present.

pub fn transfer_function(&self) -> TransferFunction

Derive the transfer function from CICP metadata.

Returns the TransferFunction corresponding to the CICP transfer_characteristics code, or Unknown if CICP is absent or the code is not recognized.

pub fn color_primaries(&self) -> ColorPrimaries

Derive the color primaries from CICP metadata.

Returns Bt709 if CICP is absent.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Default for Metadata

fn default() -> Metadata

Returns the “default value” for a type.

impl From<&ImageInfo> for Metadata

fn from(info: &ImageInfo) -> Self

Converts to this type from the input type.

impl PartialEq for Metadata

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