Struct Scale

pub struct Scale {
    pub name: String,
    pub description: String,
    pub raw_text: String,
    pub tones: Vec<Tone>,
    /* private fields */
}

The Scale is the representation of the SCL file.

It contain several key features. Most importantly it has a Scale::count() and a vector of Tones.

In most normal use, you will simply pass around instances of this struct to a Tuning, but in some cases you may want to create or inspect this struct yourself. Especially if you are displaying this struct to your end users, you may want to use the Scale::raw_text or Scale::count() methods.

Fields

name: String

The name in the SCL file. Informational only.

description: String

The description in the SCL file. Informational only.

raw_text: String

The raw text of the SCL file used to create this Scale.

tones: Vec<Tone>

The tones.

Implementations

impl Scale

pub fn new() -> Self

Constructs an empty scale.

pub fn count(&self) -> usize

Number of tones in the scale.

pub fn read_scl_file<P>(fname: P) -> Result<Self, TuningError>

where P: AsRef<Path>,

Returns a Scale or an error from the SCL file contents in fname.

pub fn parse_scl_data(scl_contents: &str) -> Result<Self, TuningError>

Returns a Scale or an error from the SCL file contents in memory.

pub fn even_temperament_12_note_scale() -> Self

Provides a utility scale which is the “standard tuning” scale.

pub fn even_division_of_span_by_m( span: u32, m: u32, ) -> Result<Self, TuningError>

Provides a scale refered to as “ED2-17” or “ED3-24” by dividing the span into m points. Scale::even_division_of_span_by_m(2, 12) should be the Scale::even_temperament_12_note_scale().

let s1 = Scale::even_division_of_span_by_m(2, 12).unwrap(); // equal to `even_temperament_12_note_scale()`
let s2 = Scale::even_division_of_span_by_m(2, 17).unwrap(); // ED2-17
let s3 = Scale::even_division_of_span_by_m(3, 24).unwrap(); // ED3-24

pub fn even_division_of_cents_by_m( cents: f64, m: u32, last_label: &str, ) -> Result<Self, TuningError>

Provides a scale which divides cents into m steps. It is less frequently used than Scale::even_division_of_span_by_m() for obvious reasons. If you want the last cents label labeled differently than the cents argument, pass in the associated label.

Trait Implementations

impl Clone for Scale

fn clone(&self) -> Scale

Returns a duplicate of the value.

const 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() -> Scale

Returns the “default value” for a type.