Skip to main content

PitchRangeMask

Struct PitchRangeMask 

Source
pub struct PitchRangeMask {
    pub bits: u128,
}
Expand description

A bitmask over the 128 MIDI keys, with bit n set when MIDI key n is present.

Unlike PitchClassMask, this preserves octave, so it represents a concrete set of sounding pitches rather than pitch classes.

Fields§

§bits: u128

The packed key bits, with bit n corresponding to MIDI key n.

Implementations§

Source§

impl PitchRangeMask

Source

pub fn set(&mut self, midi_key: u8)

Adds midi_key to the set.

Source

pub fn clear(&mut self, midi_key: u8)

Removes midi_key from the set.

Source

pub fn contains(self, midi_key: u8) -> bool

Returns true if midi_key is present in the set.

Source

pub fn union(self, other: Self) -> Self

Returns the union of this mask with other.

Source

pub fn intersection(self, other: Self) -> Self

Returns the intersection of this mask with other.

Source

pub fn difference(self, other: Self) -> Self

Returns the keys present in this mask but not in other.

Source

pub fn to_pitches(self) -> Vec<Pitch>

Returns the set keys as concrete Pitch values in ascending order.

Trait Implementations§

Source§

impl Clone for PitchRangeMask

Source§

fn clone(&self) -> PitchRangeMask

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PitchRangeMask

Source§

impl Debug for PitchRangeMask

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PitchRangeMask

Source§

fn default() -> PitchRangeMask

Returns the “default value” for a type. Read more
Source§

impl Eq for PitchRangeMask

Source§

impl Hash for PitchRangeMask

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PitchRangeMask

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PitchRangeMask

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.