Struct Scale 

pub struct Scale {
    pub tonic: Pitch,
    pub octave: u8,
    pub scale_type: ScaleType,
    pub mode: Option<Mode>,
    pub intervals: Vec<Interval>,
    pub direction: Direction,
}

A scale.

Fields

tonic: Pitch

The root note of the scale.

octave: u8

The octave of the root note of the scale.

scale_type: ScaleType

The type of scale (diatonic, melodic minor, harmonic minor).

mode: Option<Mode>

The mode of the scale.

intervals: Vec<Interval>

The list of intervals in the scale.

direction: Direction

The direction of the scale, ascending or descending.

Implementations

impl Scale

pub fn new( scale_type: ScaleType, tonic: Pitch, octave: u8, mode: Option<Mode>, direction: Direction, ) -> Result<Self, ScaleError>

Create a new scale with a given direction.

pub fn from_regex_in_direction( string: &str, direction: Direction, ) -> Result<Self, ScaleError>

Parse a scale from a regex.

pub fn from_regex(string: &str) -> Result<Self, ScaleError>

pub fn absolute_intervals(&self) -> Vec<Interval>

Trait Implementations

impl Clone for Scale

fn clone(&self) -> Scale

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scale

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

Formats the value using the given formatter.

impl Default for Scale

fn default() -> Self

Returns the “default value” for a type.

impl Notes for Scale

fn notes(&self) -> Vec<Note>

Get the sequence of notes.

fn print_notes(&self)

Print the sequence of notes.