Enum Mode 

pub enum Mode {
    Chromatic,
    Ionian,
    Dorian,
    Phrygian,
    Lydian,
    Mixolydian,
    Aeolian,
    Locrian,
}

The scale a pattern’s pitch controls walk in.

Chromatic is “off”: every semitone is available and the diatonic chord types have no degree to derive a quality from, so they collapse to major and major seventh.

Variants

Chromatic

Ionian

Dorian

Phrygian

Lydian

Mixolydian

Aeolian

Locrian

Implementations

impl Mode

pub const ALL: [Mode; 8]

pub const fn label(self) -> &'static str

pub const fn index(self) -> u8

pub fn from_index(index: u8) -> Self

pub fn stepped(self, delta: i32) -> Self

pub const fn rotation(self) -> Option<usize>

How far into the major scale this mode starts. None for Chromatic, which is not a rotation of anything.

pub fn scale(self) -> Option<[i32; 7]>

Semitones above the tonic for each degree of this mode, ascending.

None for Chromatic, which is not a scale — every semitone is a degree, and asking which one a note is on has no answer.

pub fn degree_of(self, note: u8, tonic: u8) -> Option<usize>

Which degree of this mode note sits on, given a tonic pitch class.

None when the note is not in the scale — a borrowed note, which is a feature rather than a mistake, and which the diatonic chord types have no quality for.

pub fn walk(self, note: u8, tonic: u8, steps: i32) -> u8

The note steps degrees away from note in this mode.

Under Chromatic this is a semitone walk. In a mode it is a scale walk: the pitch control moves by degrees, so holding the key sweeps through the key rather than through every semitone in it. A note that is not in the scale — one that was set before the mode was, or borrowed on purpose — snaps onto the scale on the first press rather than staying off it forever.

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Mode

impl Debug for Mode

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

Formats the value using the given formatter.

impl Default for Mode

fn default() -> Mode

Returns the “default value” for a type.

impl Eq for Mode

impl PartialEq for Mode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Mode