Struct libatm::midi_note::MIDINote

pub struct MIDINote {
    pub note_type: MIDINoteType,
    pub octave: u32,
}

MIDI note

Represents key on a piano, combining a note type with an octave. For example, middle C would be represented as MIDINote { note_type: MIDINoteType::C, octave: 4 }. For a detailed table of MIDI notes and octave numbers, see document here: https://www.cs.cmu.edu/~music/cmsip/readings/Standard-MIDI-file-format-updated.pdf.

Fields

note_type: MIDINoteType

octave: u32

Methods

impl MIDINote

pub fn new(note_type: MIDINoteType, octave: u32) -> Self

Create new MIDINote

Arguments

• note_type: MIDINoteType
• octave: integer between -1 and 9

Examples

// Middle C
let note = libatm::MIDINote::new(libatm::MIDINoteType::C, 4);
assert_eq!(60, note.convert());

Notes

The octave parameter is not validated, but must be between -1 and 9 in order to represent a valid MIDI note.

pub fn convert(&self) -> u32

Convert MIDI note to an integer representation (MIDI note number)

The empty note (A.K.A. silence) is represented as u32::max_value(). The MIDI Tuning Standard only represents pitches up to 127, but instead of choosing some arbitrary number larger than 127, u32::max_value() is easily distinguishable.

Trait Implementations

impl Clone for MIDINote

fn clone(&self) -> MIDINote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for MIDINote

impl Eq for MIDINote

impl Ord for MIDINote

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

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

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

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

This method tests for !=.

impl PartialOrd<MIDINote> for MIDINote

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

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

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

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

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

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

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

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

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

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

impl Debug for MIDINote

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

Formats the value using the given formatter.

impl<'a> FromStr for MIDINote

type Err = ParseMIDINoteError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for MIDINote

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 StructuralPartialEq for MIDINote

impl StructuralEq for MIDINote

impl FromIterator<MIDINote> for MIDINoteVec

fn from_iter<I: IntoIterator<Item = MIDINote>>(iter: I) -> Self

Creates a value from an iterator.