Struct surgefilter_comb::imports::Scale

pub struct Scale {
    pub name: String,
    pub description: String,
    pub raw_text: TuningData,
    pub count: usize,
    pub tones: Vec<Tone, Global>,
}

From: http://huygens-fokker.org/scala/scl_format.html The files are human readable ASCII or 8-bit character text-files. The file type is .scl . There is one scale per file. Lines beginning with an exclamation mark are regarded as comments and are to be ignored. The first (non comment) line contains a short description of the scale, but long lines are possible and should not give a read error. The description is only one line. If there is no description, there should be an empty line. The second line contains the number of notes. This number indicates the number of lines with pitch values that follow. In principle there is no upper limit to this, but it is allowed to reject files exceeding a certain size. The lower limit is 0, which is possible since degree 0 of 1/1 is implicit. Spaces before or after the number are allowed.

After that come the pitch values, each on a separate line, either as a ratio or as a value in cents. If the value contains a period, it is a cents value, otherwise a ratio. Ratios are written with a slash, and only one. Integer values with no period or slash should be regarded as such, for example “2” should be taken as “2/1”. Numerators and denominators should be supported to at least 231-1 = 2147483647. Anything after a valid pitch value should be ignored. Space or horizontal tab characters are allowed and should be ignored. Negative ratios are meaningless and should give a read error. For a description of cents, go here. The first note of 1/1 or 0.0 cents is implicit and not in the files. Files for which Scala gives Error in file format are incorrectly formatted. They should give a read error and be rejected.

Fields

name: String

description: String

raw_text: TuningData

count: usize

tones: Vec<Tone, Global>

Implementations

impl Scale

pub fn is_valid(&self) -> bool

pub fn even_temperament_12_note_scale() -> Scale

pub fn scale_432() -> Scale

Trait Implementations

impl Clone for Scale

pub fn clone(&self) -> Scale

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scale

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

Formats the value using the given formatter.

impl Default for Scale

pub fn default() -> Scale

Returns the “default value” for a type.

impl Display for Scale

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

Formats the value using the given formatter.

impl<'_, R> From<&'_ mut BufReader<R>> for Scale where
    R: Read, 

pub fn from(reader: &mut BufReader<R>) -> Scale

Performs the conversion.

impl From<SclFileName> for Scale

pub fn from(x: SclFileName) -> Scale

Performs the conversion.

impl From<TuningData> for Scale

pub fn from(x: TuningData) -> Scale

Performs the conversion.

impl Init for Scale

pub fn init(&mut self)