Struct csound::ControlChannelType

pub struct ControlChannelType { /* fields omitted */ }

Defines the types of csound bus cahnnels

and if the channel is an input or an output

Methods

impl ControlChannelType

pub const CSOUND_UNKNOWN_CHANNEL: ControlChannelType

Unknown channel - use it to request the channel type

pub const CSOUND_CONTROL_CHANNEL: ControlChannelType

Define a csound control channel

pub const CSOUND_AUDIO_CHANNEL: ControlChannelType

Define a audio channel (chanel content is and array with ksmps elements)

pub const CSOUND_STRING_CHANNEL: ControlChannelType

String channel

pub const CSOUND_PVS_CHANNEL: ControlChannelType

Pvs channel

pub const CSOUND_VAR_CHANNEL: ControlChannelType

Generic channel

pub const CSOUND_CHANNEL_TYPE_MASK: ControlChannelType

pub const CSOUND_INPUT_CHANNEL: ControlChannelType

pub const CSOUND_OUTPUT_CHANNEL: ControlChannelType

pub const fn empty() -> ControlChannelType

Returns an empty set of flags

pub const fn all() -> ControlChannelType

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<ControlChannelType>

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) -> ControlChannelType

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Copy for ControlChannelType

impl Eq for ControlChannelType

impl Clone for ControlChannelType

fn clone(&self) -> ControlChannelType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<ControlChannelType> for ControlChannelType

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

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

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

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

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

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

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

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

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

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

impl Extend<ControlChannelType> for ControlChannelType

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

Extends a collection with the contents of an iterator.

impl PartialEq<ControlChannelType> for ControlChannelType

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

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

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

This method tests for !=.

impl Ord for ControlChannelType

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl Hash for ControlChannelType

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, 

Feeds a slice of this type into the given [Hasher].

impl Debug for ControlChannelType

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

Formats the value using the given formatter.

impl Sub<ControlChannelType> for ControlChannelType

type Output = ControlChannelType

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ControlChannelType> for ControlChannelType

fn sub_assign(&mut self, other: ControlChannelType)

Disables all flags enabled in the set.

impl Not for ControlChannelType

type Output = ControlChannelType

The resulting type after applying the ! operator.

fn not(self) -> ControlChannelType

Returns the complement of this set of flags.

impl BitAnd<ControlChannelType> for ControlChannelType

type Output = ControlChannelType

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<ControlChannelType> for ControlChannelType

type Output = ControlChannelType

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<ControlChannelType> for ControlChannelType

type Output = ControlChannelType

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<ControlChannelType> for ControlChannelType

fn bitand_assign(&mut self, other: ControlChannelType)

Disables all flags disabled in the set.

impl BitOrAssign<ControlChannelType> for ControlChannelType

fn bitor_assign(&mut self, other: ControlChannelType)

Adds the set of flags.

impl BitXorAssign<ControlChannelType> for ControlChannelType

fn bitxor_assign(&mut self, other: ControlChannelType)

Toggles the set of flags.

impl FromIterator<ControlChannelType> for ControlChannelType

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

Creates a value from an iterator.

impl Octal for ControlChannelType

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

Formats the value using the given formatter.

impl Binary for ControlChannelType

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

Formats the value using the given formatter.

impl LowerHex for ControlChannelType

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

Formats the value using the given formatter.

impl UpperHex for ControlChannelType

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

Formats the value using the given formatter.