Enum VoiceID 

pub enum VoiceID {
    Wildcard,
    ID(i32),
}

The identifier given to a specific voice. This is also known as the “note ID”.

Variants

Wildcard

The note can belong to any voice.

ID(i32)

The note belongs to the voice with the given ID.

Implementations

impl VoiceID

pub const fn id(&self) -> Option<i32>

Return the ID of the voice if it exists, or return None if it is a wildcard (the note can belong to any voice).

pub const fn is_wildcard(&self) -> bool

Returns true if this is a wildcard (the note can belong to any voice).

pub fn id_or_fallback(&self, key: Key, channel: Channel) -> i32

Compute a voice ID if the host didn’t provide one. Polyphonic modulation will not work in this case, but playing notes will.

Trait Implementations

impl Clone for VoiceID

fn clone(&self) -> VoiceID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VoiceID

impl Debug for VoiceID

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

Formats the value using the given formatter.

impl Eq for VoiceID

impl Hash for VoiceID

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 Ord for VoiceID

fn cmp(&self, other: &VoiceID) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for VoiceID

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VoiceID

fn partial_cmp(&self, other: &VoiceID) -> 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 StructuralPartialEq for VoiceID