Struct ChannelMask

pub struct ChannelMask { /* private fields */ }

The channel mask

This field is used to communicate that the channels in the file differ from FLAC’s default channel assignment definitions.

It is generally used for multi-channel audio and stored within the VorbisComment metadata block as the fields::CHANNEL_MASK field.

Example

use flac_codec::metadata::{ChannelMask, Channel};

let mask = "0x003F".parse::<ChannelMask>().unwrap();

let mut channels = mask.channels();
assert_eq!(channels.next(), Some(Channel::FrontLeft));
assert_eq!(channels.next(), Some(Channel::FrontRight));
assert_eq!(channels.next(), Some(Channel::FrontCenter));
assert_eq!(channels.next(), Some(Channel::Lfe));
assert_eq!(channels.next(), Some(Channel::BackLeft));
assert_eq!(channels.next(), Some(Channel::BackRight));
assert_eq!(channels.next(), None);

Implementations

impl ChannelMask

pub fn channels(&self) -> impl Iterator<Item = Channel>

Iterates over all the mask’s defined channels

Trait Implementations

impl Clone for ChannelMask

fn clone(&self) -> ChannelMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelMask

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

Formats the value using the given formatter.

impl Default for ChannelMask

fn default() -> ChannelMask

Returns the “default value” for a type.

impl Display for ChannelMask

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

Formats the value using the given formatter.

impl From<ChannelMask> for u32

fn from(mask: ChannelMask) -> u32

Converts to this type from the input type.

impl From<u32> for ChannelMask

fn from(mask: u32) -> ChannelMask

Converts to this type from the input type.

impl FromStr for ChannelMask

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Copy for ChannelMask