Struct exr::meta::MetaData

pub struct MetaData {
    pub requirements: Requirements,
    pub headers: Headers,
}

Contains the complete meta data of an exr image. Defines how the image is split up in the file, the number and type of images and channels, and various other attributes. The usage of custom attributes is encouraged.

Fields

requirements: Requirements

Some flags summarizing the features that must be supported to decode the file.

headers: Headers

One header to describe each layer in this file.

Implementations

impl MetaData

#[must_use]pub fn read_from_file(path: impl AsRef<Path>, pedantic: bool) -> Result<Self>

Read the exr meta data from a file. Use read_from_unbuffered instead if you do not have a file. Does not validate the meta data.

#[must_use]pub fn read_from_unbuffered(
    unbuffered: impl Read,
    pedantic: bool
) -> Result<Self>

Buffer the reader and then read the exr meta data from it. Use read_from_buffered if your reader is an in-memory reader. Use read_from_file if you have a file path. Does not validate the meta data.

#[must_use]pub fn read_from_buffered(buffered: impl Read, pedantic: bool) -> Result<Self>

Read the exr meta data from a reader. Use read_from_file if you have a file path. Use read_from_unbuffered if this is not an in-memory reader. Does not validate the meta data.

pub fn read_offset_tables(
    read: &mut PeekRead<impl Read>,
    headers: &Headers
) -> Result<OffsetTables>

Read one offset table from the reader for each header.

pub fn skip_offset_tables(
    read: &mut PeekRead<impl Read>,
    headers: &Headers
) -> Result<usize>

Skip the offset tables by advancing the reader by the required byte count.

pub fn validate(headers: &[Header], pedantic: bool) -> Result<Requirements>

Validates this meta data. Returns the minimal possible requirements.

Trait Implementations

impl Clone for MetaData

fn clone(&self) -> MetaData

Returns a copy of the value.

pub 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 PartialEq<MetaData> for MetaData

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for MetaData