Struct musical_note::Key

pub struct Key {
    pub tonic: (NoteName, Accidental),
    pub scale: Scale,
}

Fields

tonic: (NoteName, Accidental)

scale: Scale

Implementations

impl Key

pub fn new(note: NoteName, accidental: Accidental, scale: Scale) -> Self

pub fn get_root(&self) -> [u8; 2]

[root_midi, root_index]

root_midi is u8 in rage 0..12, based on note name and accidental. root_index is u8 in rage 0..7, based only on note name.

pub fn from_str(name: &str, scale: Scale) -> Option<Self>

“as” or “eis” — without octave.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Self

Returns the “default value” for a type.

impl From<(&String, Scale)> for Key

fn from(value: (&String, Scale)) -> Self

Converts to this type from the input type.

impl PartialEq<Key> for Key

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

fn partial_cmp(&self, other: &Key) -> 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 Copy for Key

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key