Struct AudioChannelMask

pub struct AudioChannelMask { /* private fields */ }

Mask used to indicate which channels are present in the stream.

See https://en.wikipedia.org/wiki/Surround_sound#Standard_speaker_channels and https://en.wikipedia.org/wiki/22.2_surround_sound for more information.

Implementations

impl AudioChannelMask

pub const FrontLeft: AudioChannelMask

Front left

pub const FrontRight: AudioChannelMask

Front right

pub const FrontCenter: AudioChannelMask

Front center

pub const LowFrequency1: AudioChannelMask

Low frequency

pub const BackLeft: AudioChannelMask

Back left

pub const BackRight: AudioChannelMask

Back right

pub const FrontLeftCenter: AudioChannelMask

Front left of center

pub const FrontRightCenter: AudioChannelMask

Front right of center

pub const BackCenter: AudioChannelMask

Back center

pub const SideLeft: AudioChannelMask

Side left

pub const SideRight: AudioChannelMask

Side right

pub const TopCenter: AudioChannelMask

Top center

pub const TopFrontLeft: AudioChannelMask

Front left height

pub const TopFrontCenter: AudioChannelMask

Front center height

pub const TopFrontRight: AudioChannelMask

Front right height

pub const TopBackLeft: AudioChannelMask

Rear left height

pub const TopBackCenter: AudioChannelMask

Rear center height

pub const TopBackRight: AudioChannelMask

Rear right height

pub const LowFrequency2: AudioChannelMask

Low frequency 2

pub const TopSideLeft: AudioChannelMask

Top side left

pub const TopSideRight: AudioChannelMask

Top side right

pub const BottomFrontCenter: AudioChannelMask

Bottom front center

pub const BottomFrontLeft: AudioChannelMask

Bottom front left

pub const BottomFrontRight: AudioChannelMask

Bottom front right

pub const fn bits(&self) -> u32

Returns the underlying bits of the bitmask.

pub const fn all_bits() -> Self

Returns a bitmask that contains all values.

This will include bits that do not have any flags. Use ::all_flags() if you only want to use flags.

pub const fn all_flags() -> Self

Returns a bitmask that contains all flags.

pub const fn is_all_bits(&self) -> bool

Returns true if the bitmask contains all values.

This will check for bits == !0, use .is_all_flags() if you only want to check for all flags

pub const fn is_all_flags(&self) -> bool

Returns true if the bitmask contains all flags.

This will fail if any unused bit is set, consider using .truncate() first.

pub const fn all() -> Self

👎Deprecated: Please use the ::all_bits() constructor

Returns a bitmask that contains all values.

This will include bits that do not have any flags. Use ::all_flags() if you only want to use flags.

pub const fn is_all(&self) -> bool

👎Deprecated: Please use the .is_all_bits() method

Returns true if the bitmask contains all values.

This will check for bits == !0, use .is_all_flags() if you only want to check for all flags

pub const fn full() -> Self

👎Deprecated: Please use the ::all_flags() constructor

Returns a bitmask that contains all flags.

pub const fn is_full(&self) -> bool

👎Deprecated: Please use the .is_all_flags() method

Returns true if the bitmask contains all flags.

This will fail if any unused bit is set, consider using .truncate() first.

pub const fn none() -> Self

Returns a bitmask that does not contain any values.

pub const fn is_none(&self) -> bool

Returns true if the bitmask does not contain any values.

pub const fn truncate(&self) -> Self

Returns a bitmask that only has bits corresponding to flags

pub const fn intersects(&self, other: Self) -> bool

Returns true if self intersects with any value in other, or if other does not contain any values.

This is equivalent to (self & other) != 0 || other == 0.

pub const fn contains(&self, other: Self) -> bool

Returns true if self contains all values of other.

This is equivalent to (self & other) == other.

pub const fn not(self) -> Self

Returns the bitwise NOT of the bitmask.

pub const fn and(self, other: Self) -> Self

Returns the bitwise AND of the bitmask.

pub const fn or(self, other: Self) -> Self

Returns the bitwise OR of the bitmask.

pub const fn xor(self, other: Self) -> Self

Returns the bitwise XOR of the bitmask.

Trait Implementations

impl Binary for AudioChannelMask

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

Formats the value using the given formatter.

impl BitAnd for AudioChannelMask

type Output = AudioChannelMask

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for AudioChannelMask

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for AudioChannelMask

type Output = AudioChannelMask

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for AudioChannelMask

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for AudioChannelMask

type Output = AudioChannelMask

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for AudioChannelMask

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for AudioChannelMask

fn clone(&self) -> AudioChannelMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioChannelMask

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

Formats the value using the given formatter.

impl From<AudioChannelMask> for u32

fn from(val: AudioChannelMask) -> u32

Converts to this type from the input type.

impl From<u32> for AudioChannelMask

fn from(val: u32) -> Self

Converts to this type from the input type.

impl Hash for AudioChannelMask

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 LowerHex for AudioChannelMask

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

Formats the value using the given formatter.

impl Not for AudioChannelMask

type Output = AudioChannelMask

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for AudioChannelMask

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

Formats the value using the given formatter.

impl Ord for AudioChannelMask

fn cmp(&self, other: &AudioChannelMask) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<u32> for AudioChannelMask

fn eq(&self, other: &u32) -> 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 PartialEq for AudioChannelMask

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

fn partial_cmp(&self, other: &AudioChannelMask) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl UpperHex for AudioChannelMask

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

Formats the value using the given formatter.

impl Copy for AudioChannelMask

impl Eq for AudioChannelMask

impl StructuralPartialEq for AudioChannelMask