Enum ScaleCandidate 

pub enum ScaleCandidate {
    Mode {
        kind: ModeKind,
        rank: u8,
        reason: &'static str,
    },
    Scale {
        kind: ScaleKind,
        rank: u8,
        reason: &'static str,
    },
}

Represents a recommended scale or mode for a chord.

Variants

Mode

A mode candidate

Fields

kind: ModeKind

The mode kind

rank: u8

Ranking (1 = most relevant)

reason: &'static str

Reason why this mode fits the chord

Scale

A scale candidate

Fields

kind: ScaleKind

The scale kind

rank: u8

Ranking (1 = most relevant)

reason: &'static str

Reason why this scale fits the chord

Implementations

impl ScaleCandidate

pub fn rank(&self) -> u8

Returns the rank of this candidate

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

Returns the reason for this candidate

pub fn name(&self) -> String

Returns the name of this candidate

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

Returns the description of this candidate

pub fn notes(&self, root: Note) -> Vec<Note>

Returns the notes of this candidate rooted at the given note

Trait Implementations

impl Clone for ScaleCandidate

fn clone(&self) -> ScaleCandidate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScaleCandidate

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

Formats the value using the given formatter.

impl Deserialize<'static> for ScaleCandidate

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

where __D: Deserializer<'static>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScaleCandidate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScaleCandidate

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 ScaleCandidate