Struct SourceMetadata 

#[non_exhaustive]
pub struct SourceMetadata {

    pub format: Format,
    pub size: Option<u64>,
    pub width: u32,
    pub height: u32,
    pub pixel: PixelFormat,
    pub channels: usize,
    pub has_alpha: bool,
    pub bits_per_sample: Option<u8>,
    pub orientation: Orientation,
    pub pages: u32,
    pub animation: Option<Animation>,
    pub density: Option<Density>,
    pub progressive: bool,
    pub palette: bool,
    pub chroma_subsampling: Option<&'static str>,
    pub background: Option<Background>,
    pub compression: Option<&'static str>,
    pub comments: Vec<Comment>,
    pub icc: Option<Arc<[u8]>>,
    pub exif: Option<Arc<[u8]>>,
    pub xmp: Option<Arc<[u8]>>,
}

What a source file says about itself, read from its headers (sharp’s metadata()). Nothing here costs a pixel decode.

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.

format: Format

The file’s format.

size: Option<u64>

The file’s size in bytes, when it was opened from a path.

width: u32

Width as stored, before any orientation is applied.

height: u32

Height as stored.

pixel: PixelFormat

The pixel format the decoder produces.

channels: usize

Channels in that pixel format, alpha included.

has_alpha: bool

Whether there is an alpha channel.

bits_per_sample: Option<u8>

Bits per stored sample, which may be fewer than the decoder’s output (a 4-bit PNG, a 10-bit AVIF).

orientation: Orientation

How the image must be turned to display upright; EXIF’s 1–8 as Orientation::exif gives it.

pages: u32

Pages in the document, at least 1 (multi-page TIFF).

animation: Option<Animation>

The animation’s frames, loop count and delays, for more than one frame.

density: Option<Density>

The stated resolution, if any.

progressive: bool

Progressive JPEG, or interlaced PNG or GIF.

palette: bool

Samples index a palette.

chroma_subsampling: Option<&'static str>

Chroma subsampling as sharp spells it ("4:2:0", "4:4:4", …).

background: Option<Background>

The background colour the file names (PNG bKGD, GIF).

compression: Option<&'static str>

The compression scheme where a format has several.

comments: Vec<Comment>

Text entries (PNG text chunks, JPEG and GIF comments).

icc: Option<Arc<[u8]>>

The embedded ICC profile.

exif: Option<Arc<[u8]>>

The EXIF block, TIFF-structured, as the file stores it.

xmp: Option<Arc<[u8]>>

The XMP packet.

Implementations

impl SourceMetadata

pub const fn has_profile(&self) -> bool

Whether the file carries an ICC profile (sharp’s hasProfile).

pub const fn oriented_width(&self) -> u32

Width once turned upright, as sharp’s autoOrient reports it.

pub const fn oriented_height(&self) -> u32

Height once turned upright.

Trait Implementations

impl Clone for SourceMetadata

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceMetadata

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

Formats the value using the given formatter.

impl PartialEq for SourceMetadata

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SourceMetadata