Enum ModeKind 

#[repr(u8)]
pub enum ModeKind {
    Ionian = 0,
    Dorian = 1,
    Phrygian = 2,
    Lydian = 3,
    Mixolydian = 4,
    Aeolian = 5,
    Locrian = 6,
    LocrianNatural6 = 7,
    IonianSharp5 = 8,
    DorianSharp4 = 9,
    PhrygianDominant = 10,
    LydianSharp2 = 11,
    Ultralocrian = 12,
    DorianFlat2 = 13,
    LydianAugmented = 14,
    LydianDominant = 15,
    MixolydianFlat6 = 16,
    LocrianNatural2 = 17,
    Altered = 18,
}

An enum representing a mode kind (type of mode).

Each mode kind has an explicit list of intervals that define the mode. These intervals are NOT derived by rotation - they are the authoritative definition. Parent scale information is included for documentation purposes only.

Variants

Ionian = 0

Ionian mode (1st mode of major scale).

Dorian = 1

Dorian mode (2nd mode of major scale).

Phrygian = 2

Phrygian mode (3rd mode of major scale).

Lydian = 3

Lydian mode (4th mode of major scale).

Mixolydian = 4

Mixolydian mode (5th mode of major scale).

Aeolian = 5

Aeolian mode (6th mode of major scale).

Locrian = 6

Locrian mode (7th mode of major scale).

LocrianNatural6 = 7

Locrian ♮6 mode (2nd mode of harmonic minor).

IonianSharp5 = 8

Ionian ♯5 mode (3rd mode of harmonic minor).

DorianSharp4 = 9

Dorian ♯4 mode (4th mode of harmonic minor).

PhrygianDominant = 10

Phrygian Dominant mode (5th mode of harmonic minor).

LydianSharp2 = 11

Lydian ♯2 mode (6th mode of harmonic minor).

Ultralocrian = 12

Ultralocrian mode (7th mode of harmonic minor).

DorianFlat2 = 13

Dorian ♭2 mode (2nd mode of melodic minor).

LydianAugmented = 14

Lydian Augmented mode (3rd mode of melodic minor).

LydianDominant = 15

Lydian Dominant mode (4th mode of melodic minor).

MixolydianFlat6 = 16

Mixolydian ♭6 mode (5th mode of melodic minor).

LocrianNatural2 = 17

Locrian ♮2 mode (6th mode of melodic minor).

Altered = 18

Altered / Super Locrian mode (7th mode of melodic minor).

Implementations

impl ModeKind

pub fn parent_scale(&self) -> ScaleKind

Returns the parent scale kind for this mode (for documentation only).

This is metadata - the intervals are NOT derived from the parent.

pub fn parent_degree(&self) -> u8

Returns the degree of the parent scale that this mode starts on (for documentation only).

This is metadata - the intervals are NOT derived from the parent.

impl ModeKind

pub fn ascii_name(&self) -> &'static str

Returns the ASCII name of the mode (using ‘b’, ‘#’, ‘nat’ instead of Unicode symbols).

Trait Implementations

impl Clone for ModeKind

fn clone(&self) -> ModeKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ModeKind

impl Debug for ModeKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModeKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ModeKind

impl HasDescription for ModeKind

fn description(&self) -> &'static str

Returns the description of the type.

impl HasIntervals for ModeKind

fn intervals(&self) -> &'static [Interval]

Returns the intervals of the type.

impl HasName for ModeKind

fn name(&self) -> String

Returns the computed name of the type.

fn name_ascii(&self) -> String

Returns the computed name of the type in ASCII.

impl HasStaticName for ModeKind

fn static_name(&self) -> &'static str

Returns the static name of the type.

impl Hash for ModeKind

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 ModeKind

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ModeKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ModeKind

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ModeKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModeKind