Enum musictheory::types::Note

pub enum Note {
    A(Accidental),
    B(Accidental),
    C(Accidental),
    D(Accidental),
    E(Accidental),
    F(Accidental),
    G(Accidental),
}

Notes are names given to a specific PitchClass.

Variants

A(Accidental)

B(Accidental)

C(Accidental)

D(Accidental)

E(Accidental)

F(Accidental)

G(Accidental)

Methods

impl Note

pub fn sharps() -> [Note; 12]

pub fn flats() -> [Note; 12]

pub fn sharp(&self) -> bool

True if a Note is sharp or double sharp.

pub fn flat(&self) -> bool

True if a Note is flat or double flat.

pub fn natural(&self) -> bool

True if a Note is natural.

pub fn accidental(&self) -> Accidental

Return associated Accidental.

pub fn pitch_class(&self) -> PitchClass

PitchClass of this Note.

pub fn enharmonic(&self) -> bool

Is this Note enharmonic.

Trait Implementations

impl Add<Interval> for Note

type Output = Option<Self>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Note

impl Debug for Note

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

Formats the value using the given formatter.

impl Display for Note

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

Formats the value using the given formatter.

impl Eq for Note

impl Ord for Note

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

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

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

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

This method tests for !=.

impl PartialOrd<Note> for Note

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Note

impl StructuralPartialEq for Note

impl Sub<Interval> for Note

type Output = Option<Self>

The resulting type after applying the - operator.

fn sub(self, interval: Interval) -> Self::Output

Performs the - operation.