Struct ScaleSuggestion 

pub struct ScaleSuggestion {
    pub scale: Scale,
    pub fits_prev: bool,
    pub fits_next: bool,
    pub reasoning: String,
}

One suggestion from suggest_scales_for_bracket: a candidate scale for a lead-line gap between two chords, with which side(s) of the bracket it fits and a human-readable reasoning string.

Fields

scale: Scale

fits_prev: bool

True iff a previous chord was supplied and every one of its pitch classes lies in scale.

fits_next: bool

True iff a next chord was supplied and every one of its pitch classes lies in scale.

reasoning: String

One-line explanation of why this scale was suggested, suitable for rendering directly in a UI.

Implementations

impl ScaleSuggestion

pub fn fits_both(&self) -> bool

True if both chords were supplied and both are covered by the scale.

Trait Implementations

impl Clone for ScaleSuggestion

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScaleSuggestion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScaleSuggestion

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ScaleSuggestion

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

where __S: Serializer,

Serialize this value into the given Serde serializer.