Struct music_theory::theory::enharmonic_note::EnharmonicNote

pub struct EnharmonicNote { /* private fields */ }

An enhamonic note is a note that takes into account the enharmonic spelling.

Example:

use music_theory::theory::*;
let en = EnharmonicNote::wrap((Letter::A, Interval::SHARP)).unwrap();
assert_eq!(en.unwrap(), (Letter::A, Interval::SHARP));

Implementations

impl EnharmonicNote

pub fn spelled_as(&self, letter: Letter) -> Self

Spell an enharmonic note as an enharmonic note with a different base note but with the same note value.

Example:

use music_theory::theory::*;
let en = EnharmonicNote::wrap((Letter::A, Interval::ROOT)).unwrap();
let respelled = en.spelled_as(Letter::B);
assert_eq!(en.to_pc().to_note(), Note::ZERO);
assert_eq!(respelled.to_pc().to_note(), Note::ZERO);
assert_eq!(respelled.unwrap(), (Letter::B, Interval::FLAT2));

Trait Implementations

impl Clone for EnharmonicNote

fn clone(&self) -> EnharmonicNote

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Cyclic for EnharmonicNote

fn next(self) -> Self

Generate the next item.

fn prev(self) -> Self

Generate the previous item.

impl Debug for EnharmonicNote

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

Formats the value using the given formatter.

impl Display for EnharmonicNote

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

Formats the value using the given formatter.

impl Hash for EnharmonicNote

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 EnharmonicNote

fn cmp(&self, other: &EnharmonicNote) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<EnharmonicNote> for EnharmonicNote

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

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

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

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

impl PartialOrd<EnharmonicNote> for EnharmonicNote

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

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

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

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

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

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

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

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

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

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

impl ToNote for EnharmonicNote

fn to_note(self) -> Note

Take self and return a Note.

impl ToPC for EnharmonicNote

fn to_pc(self) -> PC

Take self and return PC.

impl Wrapper for EnharmonicNote

type Inner = (Letter, Interval)

The type the new type wraps.

fn wrap((letter, accidental): Self::Inner) -> Option<Self>

Try to wrap a Self::Inner type into the Self type.

fn unwrap(self) -> Self::Inner

Unwrap a Self type into a Self::Inner type.

impl Copy for EnharmonicNote

impl Eq for EnharmonicNote

impl StructuralEq for EnharmonicNote

impl StructuralPartialEq for EnharmonicNote