Struct HeicFile 

pub struct HeicFile { /* private fields */ }

A parsed HEIC/HEIF file.

Construct with HeicFile::open. Opening only parses the container (cheap); the CPU-heavy HEVC decode happens in decode_primary and decode_aux.

Implementations

impl HeicFile

pub fn open(data: Vec<u8>) -> RawResult<Self>

Parse a HEIC file from its raw bytes.

Only the container is parsed here, so this is cheap. The auxiliary-image table is populated up front; pixel decoding is deferred.

Errors

Returns RawError::Format if data is not a readable HEIC file.

pub fn decode_primary(&self) -> RawResult<RgbImage>

Decode the primary image to a 16-bit RGB image.

Geometric transforms (irot/imir) and grid (tiled) stitching are already applied; HDR (10/12-bit) sources are scaled to the full 16-bit range.

pub fn metadata(&self) -> ImageMetadata

Extract embedded EXIF/XMP/ICC and full typed metadata.

pub fn aux_images(&self) -> &[HeicAuxImage]

All auxiliary images (thumbnails, depth maps, HDR gain maps, auxiliary).

pub fn decode_aux(&self, aux: &HeicAuxImage) -> RawResult<RgbImage>

Decode a specific auxiliary image to a 16-bit RGB image.

Single-channel sources (depth maps, gain maps) are returned as grayscale-expanded RGB.

pub fn thumbnail(&self) -> RawResult<Option<RgbImage>>

Decode the embedded thumbnail, if the file carries one.

Returns Ok(None) when there is no thumbnail. (libheif does not expose the thumbnail’s coded bitstream, so a decoded image is returned.)

Trait Implementations

impl Debug for HeicFile

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

Formats the value using the given formatter.