Struct openexr::core::channel_list::ChannelList

#[repr(transparent)]
pub struct ChannelList(_);

Implementations

impl ChannelList

pub fn new() -> ChannelList

Create a Default channel list

pub fn insert(&mut self, name: &str, channel: &Channel)

Insert a channel

pub fn get(&self, name: &str) -> Option<&Channel>

Get a reference to a channel by name.

Returns

• Some(&Channel) - if the channel called name exists
• None - otherwise

pub fn get_mut(&mut self, name: &str) -> Option<&mut Channel>

Get a mutable reference to a channel by name.

Returns

• Some(&Channel) - if the channel called name exists
• None - otherwise

pub fn iter(&self) -> ChannelListIter<'_>

Get an iterator over the channels in the channel list

impl ChannelList

Layers

In an image file with many channels it is sometimes useful to group the channels into “layers”, that is, into sets of channels that logically belong together. Grouping channels into layers is done using a naming convention: channel C in layer L is called “L.C”.

For example, a computer graphic image may contain separate R, G and B channels for light that originated at each of several different virtual light sources. The channels in this image might be called “light1.R”, “light1.G”, “light1.B”, “light2.R”, “light2.G”, “light2.B”, etc.

Note that this naming convention allows layers to be nested; for example, “light1.specular.R” identifies the “R” channel in the “specular” sub-layer of layer “light1”.

Channel names that don’t contain a “.” or that contain a “.” only at the beginning or at the end are not considered to be part of any layer.

pub fn layers(&self) -> Vec<String>

Get the set of layers in the file.

pub fn channels_in_layer(&self, layer: &str) -> ChannelListIter<'_>

Get an iterator over the channels belonging to a particular layer

pub fn channels_with_prefix(&self, prefix: &str) -> ChannelListIter<'_>

Get an iterator over all channels whose name starts with prefix prefix

Trait Implementations

impl Default for ChannelList

fn default() -> ChannelList

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a ChannelList

type Item = (&'a str, &'a Channel)

The type of the elements being iterated over.

type IntoIter = ChannelListIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl OpaquePtr for ChannelList

type SysPointee = Imf_ChannelList_t

type Pointee = ChannelList

impl PartialEq<ChannelList> for ChannelList

fn eq(&self, rhs: &ChannelList) -> bool

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

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

This method tests for !=.