Struct MidiNote 

pub struct MidiNote(/* private fields */);

MIDI note represented as a byte.

Implementations

impl MidiNote

pub const fn new(pitch: Pitch, octave: Octave) -> Self

Create a new MidiNote from a Pitch and Octave.

use music_note::midi::{Octave, MidiNote};
use music_note::Pitch;

let note = MidiNote::new(Pitch::A, Octave::FOUR);
assert_eq!(note.into_byte(), 69);
assert_eq!(note.to_string(), "A4");

pub const fn from_byte(byte: u8) -> Self

Create a new MidiNote from a byte.

pub const fn pitch(self) -> Pitch

use music_note::midi::MidiNote;
use music_note::Pitch;

let note = MidiNote::from_byte(108);
assert_eq!(note.pitch(), Pitch::C);

pub const fn octave(self) -> Octave

use music_note::midi::{Octave, MidiNote};
use music_note::Pitch;

let note = MidiNote::new(Pitch::C, Octave::EIGHT);
assert_eq!(note.octave(), Octave::EIGHT);

Midi notes start at octave -1.

use music_note::midi::{Octave, MidiNote};

let note = MidiNote::from_byte(11);
assert_eq!(note.octave(), Octave::NEGATIVE_ONE);

pub const fn into_byte(self) -> u8

Return the byte representation of self.

Trait Implementations

impl Add<Interval> for MidiNote

type Output = MidiNote

The resulting type after applying the + operator.

fn add(self, rhs: Interval) -> Self::Output

Performs the + operation.

impl Clone for MidiNote

fn clone(&self) -> MidiNote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MidiNote

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

Formats the value using the given formatter.

impl Degree for MidiNote

type State = ()

fn state(self) -> Self::State

fn degree(self, _state: &mut Self::State, interval: Interval) -> Self

impl Display for MidiNote

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

Formats the value using the given formatter.

impl Extend<MidiNote> for MidiSet

fn extend<T: IntoIterator<Item = MidiNote>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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 From<MidiNote> for Pitch

fn from(midi: MidiNote) -> Self

Converts to this type from the input type.

impl From<MidiNote> for u8

fn from(midi: MidiNote) -> Self

Converts to this type from the input type.

impl From<u8> for MidiNote

fn from(byte: u8) -> Self

Converts to this type from the input type.

impl FromIterator<MidiNote> for Chord

fn from_iter<T: IntoIterator<Item = MidiNote>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<MidiNote> for MidiSet

fn from_iter<T: IntoIterator<Item = MidiNote>>(iter: T) -> Self

Creates a value from an iterator.

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

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.

impl PartialEq for MidiNote

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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: &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 Sub for MidiNote

type Output = Interval

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Copy for MidiNote

impl Eq for MidiNote

impl StructuralPartialEq for MidiNote