Struct minstrel::Key

pub struct Key { /* fields omitted */ }

A collection of seven notes, categorised by a Mode.

Implementations

impl Key

pub fn new(root_note: Note, mode: Mode) -> Self

Creates a new Key based on the given root_note and mode.

Examples

use minstrel::{Key, Mode, Note};

let c_major = Key::new(Note::new(0), Mode::Ionian);
let a_minor = Key::new(Note::new(9), Mode::Aeolian);

pub fn notes_disregarding_octave(self) -> [Note; 7]

Returns the key's seven notes without regard for octave numbers.

See Note::disregard_octave() for more detail.

Examples

use minstrel::{Key, Mode, Note};

let e_phrygian = Key::new(Note::new(4), Mode::Phrygian);
assert_eq!(
    e_phrygian.notes_disregarding_octave(),
    [
        Note::new(4),
        Note::new(5),
        Note::new(7),
        Note::new(9),
        Note::new(11),
        Note::new(0),
        Note::new(2),
    ]
);

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 Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.