Struct ffav::util::channel_layout::ChannelLayout

pub struct ChannelLayout { /* fields omitted */ }

Implementations

impl ChannelLayout

pub const FRONT_LEFT: ChannelLayout

pub const FRONT_RIGHT: ChannelLayout

pub const FRONT_CENTER: ChannelLayout

pub const LOW_FREQUENCY: ChannelLayout

pub const BACK_LEFT: ChannelLayout

pub const BACK_RIGHT: ChannelLayout

pub const FRONT_LEFT_OF_CENTER: ChannelLayout

pub const FRONT_RIGHT_OF_CENTER: ChannelLayout

pub const BACK_CENTER: ChannelLayout

pub const SIDE_LEFT: ChannelLayout

pub const SIDE_RIGHT: ChannelLayout

pub const TOP_CENTER: ChannelLayout

pub const TOP_FRONT_LEFT: ChannelLayout

pub const TOP_FRONT_CENTER: ChannelLayout

pub const TOP_FRONT_RIGHT: ChannelLayout

pub const TOP_BACK_LEFT: ChannelLayout

pub const TOP_BACK_CENTER: ChannelLayout

pub const TOP_BACK_RIGHT: ChannelLayout

pub const STEREO_LEFT: ChannelLayout

pub const STEREO_RIGHT: ChannelLayout

pub const WIDE_LEFT: ChannelLayout

pub const WIDE_RIGHT: ChannelLayout

pub const SURROUND_DIRECT_LEFT: ChannelLayout

pub const SURROUND_DIRECT_RIGHT: ChannelLayout

pub const LOW_FREQUENCY_2: ChannelLayout

pub const NATIVE: ChannelLayout

pub const MONO: ChannelLayout

pub const STEREO: ChannelLayout

pub const _2POINT1: ChannelLayout

pub const _2_1: ChannelLayout

pub const SURROUND: ChannelLayout

pub const _3POINT1: ChannelLayout

pub const _4POINT0: ChannelLayout

pub const _4POINT1: ChannelLayout

pub const _2_2: ChannelLayout

pub const QUAD: ChannelLayout

pub const _5POINT0: ChannelLayout

pub const _5POINT1: ChannelLayout

pub const _5POINT0_BACK: ChannelLayout

pub const _5POINT1_BACK: ChannelLayout

pub const _6POINT0: ChannelLayout

pub const _6POINT0_FRONT: ChannelLayout

pub const HEXAGONAL: ChannelLayout

pub const _6POINT1: ChannelLayout

pub const _6POINT1_BACK: ChannelLayout

pub const _6POINT1_FRONT: ChannelLayout

pub const _7POINT0: ChannelLayout

pub const _7POINT0_FRONT: ChannelLayout

pub const _7POINT1: ChannelLayout

pub const _7POINT1_WIDE: ChannelLayout

pub const _7POINT1_WIDE_BACK: ChannelLayout

pub const OCTAGONAL: ChannelLayout

pub const HEXADECAGONAL: ChannelLayout

pub const STEREO_DOWNMIX: ChannelLayout

pub const fn empty() -> ChannelLayout

Returns an empty set of flags

pub const fn all() -> ChannelLayout

Returns the set containing all flags.

pub const fn bits(&self) -> c_ulonglong

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_ulonglong) -> Option<ChannelLayout>

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

pub const fn from_bits_truncate(bits: c_ulonglong) -> ChannelLayout

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

pub const unsafe fn from_bits_unchecked(bits: c_ulonglong) -> ChannelLayout

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: ChannelLayout) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl ChannelLayout

pub fn channels(&self) -> i32

pub fn default(number: i32) -> ChannelLayout

Trait Implementations

impl Binary for ChannelLayout

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

Formats the value using the given formatter.

impl BitAnd<ChannelLayout> for ChannelLayout

type Output = ChannelLayout

The resulting type after applying the & operator.

pub fn bitand(self, other: ChannelLayout) -> ChannelLayout

Returns the intersection between the two sets of flags.

impl BitAndAssign<ChannelLayout> for ChannelLayout

pub fn bitand_assign(&mut self, other: ChannelLayout)

Disables all flags disabled in the set.

impl BitOr<ChannelLayout> for ChannelLayout

type Output = ChannelLayout

The resulting type after applying the | operator.

pub fn bitor(self, other: ChannelLayout) -> ChannelLayout

Returns the union of the two sets of flags.

impl BitOrAssign<ChannelLayout> for ChannelLayout

pub fn bitor_assign(&mut self, other: ChannelLayout)

Adds the set of flags.

impl BitXor<ChannelLayout> for ChannelLayout

type Output = ChannelLayout

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: ChannelLayout) -> ChannelLayout

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

impl BitXorAssign<ChannelLayout> for ChannelLayout

pub fn bitxor_assign(&mut self, other: ChannelLayout)

Toggles the set of flags.

impl Clone for ChannelLayout

pub fn clone(&self) -> ChannelLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ChannelLayout

impl Debug for ChannelLayout

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

Formats the value using the given formatter.

impl Eq for ChannelLayout

impl Extend<ChannelLayout> for ChannelLayout

pub fn extend<T: IntoIterator<Item = ChannelLayout>>(&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<ChannelLayout> for ChannelLayout

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

Creates a value from an iterator.

impl Hash for ChannelLayout

pub 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 ChannelLayout

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

Formats the value using the given formatter.

impl Not for ChannelLayout

type Output = ChannelLayout

The resulting type after applying the ! operator.

pub fn not(self) -> ChannelLayout

Returns the complement of this set of flags.

impl Octal for ChannelLayout

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

Formats the value using the given formatter.

impl Ord for ChannelLayout

pub fn cmp(&self, other: &ChannelLayout) -> 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<ChannelLayout> for ChannelLayout

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

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

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

This method tests for !=.

impl PartialOrd<ChannelLayout> for ChannelLayout

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ChannelLayout

impl StructuralPartialEq for ChannelLayout

impl Sub<ChannelLayout> for ChannelLayout

type Output = ChannelLayout

The resulting type after applying the - operator.

pub fn sub(self, other: ChannelLayout) -> ChannelLayout

Returns the set difference of the two sets of flags.

impl SubAssign<ChannelLayout> for ChannelLayout

pub fn sub_assign(&mut self, other: ChannelLayout)

Disables all flags enabled in the set.

impl UpperHex for ChannelLayout

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

Formats the value using the given formatter.