Struct exr::meta::attribute::ChannelList

pub struct ChannelList {
    pub list: SmallVec<[ChannelDescription; 5]>,
    pub bytes_per_pixel: usize,
    pub uniform_sample_type: Option<SampleType>,
}

A List of channels. Channels must be sorted alphabetically.

Fields

list: SmallVec<[ChannelDescription; 5]>

The channels in this list.

bytes_per_pixel: usize

The number of bytes that one pixel in this image needs.

uniform_sample_type: Option<SampleType>

The sample type of all channels, if all channels have the same type.

Implementations

impl ChannelList

pub fn new(channels: SmallVec<[ChannelDescription; 5]>) -> Self

Does not validate channel order.

pub fn channels_with_byte_offset( &self, ) -> impl Iterator<Item = (usize, &ChannelDescription)>

Iterate over the channels, and adds to each channel the byte offset of the channels sample type. Assumes the internal channel list is properly sorted.

pub fn find_index_of_channel(&self, exact_name: &Text) -> Option<usize>

Return the index of the channel with the exact name, case sensitive, or none. Potentially uses less than linear time.

impl ChannelList

pub fn byte_size(&self) -> usize

Number of bytes this would consume in an exr file.

pub fn write(&self, write: &mut impl Write) -> UnitResult

Without validation, write this instance to the byte stream. Assumes channels are sorted alphabetically and all values are validated.

pub fn read(read: &mut PeekRead<impl Read>) -> Result<Self>

Read the value without validating.

pub fn validate( &self, allow_sampling: bool, data_window: IntegerBounds, strict: bool, ) -> UnitResult

Check if channels are valid and sorted.

Trait Implementations

impl Clone for ChannelList

fn clone(&self) -> ChannelList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelList

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

Formats the value using the given formatter.

impl Hash for ChannelList

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ChannelList

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

impl StructuralPartialEq for ChannelList