Struct symphonia_core::audio::Channels

pub struct Channels { /* fields omitted */ }

Channels is a bit mask of all channels contained in a signal.

Implementations

impl Channels

pub const FRONT_LEFT: Channels

Front-left (left) or the Mono channel.

pub const FRONT_RIGHT: Channels

Front-right (right) channel.

pub const FRONT_CENTRE: Channels

Front-centre (centre) channel.

pub const REAR_LEFT: Channels

Rear-left (surround rear left) channel.

pub const REAR_CENTRE: Channels

Rear-centre (surround rear centre) channel.

pub const REAR_RIGHT: Channels

Rear-right (surround rear right) channel.

pub const LFE1: Channels

Low frequency channel 1.

pub const FRONT_LEFT_CENTRE: Channels

Front left-of-centre (left center) channel.

pub const FRONT_RIGHT_CENTRE: Channels

Front right-of-centre (right center) channel.

pub const REAR_LEFT_CENTRE: Channels

Rear left-of-centre channel.

pub const REAR_RIGHT_CENTRE: Channels

Rear right-of-centre channel.

pub const FRONT_LEFT_WIDE: Channels

Front left-wide channel.

pub const FRONT_RIGHT_WIDE: Channels

Front right-wide channel.

pub const FRONT_LEFT_HIGH: Channels

Front left-high channel.

pub const FRONT_CENTRE_HIGH: Channels

Front centre-high channel.

pub const FRONT_RIGHT_HIGH: Channels

Front right-high channel.

pub const LFE2: Channels

Low frequency channel 2.

pub const SIDE_LEFT: Channels

Side left (surround left) channel.

pub const SIDE_RIGHT: Channels

Side right (surround right) channel.

pub const TOP_CENTRE: Channels

Top centre channel.

pub const TOP_FRONT_LEFT: Channels

Top front-left channel.

pub const TOP_FRONT_CENTRE: Channels

Top centre channel.

pub const TOP_FRONT_RIGHT: Channels

Top front-right channel.

pub const TOP_REAR_LEFT: Channels

Top rear-left channel.

pub const TOP_REAR_CENTRE: Channels

Top rear-centre channel.

pub const TOP_REAR_RIGHT: Channels

Top rear-right channel.

pub const fn empty() -> Channels

Returns an empty set of flags

pub const fn all() -> Channels

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<Channels>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Channels

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Channels

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Channels)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Channels)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Channels)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Channels, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl Channels

pub fn count(self) -> usize

Gets the number of channels.

Trait Implementations

impl Binary for Channels

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

Formats the value using the given formatter.

impl BitAnd<Channels> for Channels

type Output = Channels

The resulting type after applying the & operator.

fn bitand(self, other: Channels) -> Channels

Returns the intersection between the two sets of flags.

impl BitAndAssign<Channels> for Channels

fn bitand_assign(&mut self, other: Channels)

Disables all flags disabled in the set.

impl BitOr<Channels> for Channels

type Output = Channels

The resulting type after applying the | operator.

fn bitor(self, other: Channels) -> Channels

Returns the union of the two sets of flags.

impl BitOrAssign<Channels> for Channels

fn bitor_assign(&mut self, other: Channels)

Adds the set of flags.

impl BitXor<Channels> for Channels

type Output = Channels

The resulting type after applying the ^ operator.

fn bitxor(self, other: Channels) -> Channels

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<Channels> for Channels

fn bitxor_assign(&mut self, other: Channels)

Toggles the set of flags.

impl Clone for Channels

fn clone(&self) -> Channels

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Channels

impl Debug for Channels

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

Formats the value using the given formatter.

impl Default for Channels

fn default() -> Channels

Returns the “default value” for a type.

impl Display for Channels

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

Formats the value using the given formatter.

impl Eq for Channels

impl Extend<Channels> for Channels

fn extend<T: IntoIterator<Item = Channels>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Channels> for Channels

fn from_iter<T: IntoIterator<Item = Channels>>(iterator: T) -> Channels

Creates a value from an iterator.

impl Hash for Channels

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for Channels

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

Formats the value using the given formatter.

impl Not for Channels

type Output = Channels

The resulting type after applying the ! operator.

fn not(self) -> Channels

Returns the complement of this set of flags.

impl Octal for Channels

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

Formats the value using the given formatter.

impl Ord for Channels

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Channels> for Channels

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

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

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

This method tests for !=.

impl PartialOrd<Channels> for Channels

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Channels

impl StructuralPartialEq for Channels

impl Sub<Channels> for Channels

type Output = Channels

The resulting type after applying the - operator.

fn sub(self, other: Channels) -> Channels

Returns the set difference of the two sets of flags.

impl SubAssign<Channels> for Channels

fn sub_assign(&mut self, other: Channels)

Disables all flags enabled in the set.

impl UpperHex for Channels

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

Formats the value using the given formatter.