Struct Scale 

pub struct Scale { /* private fields */ }

Implementations

impl Scale

pub fn new(tonic_pitch: u7, scale_mode: ScaleMode) -> Self

Creates a new Scale

Examples found in repository

examples/scales_example.rs (lines 13-16)

fn main() -> Result<(), Box<dyn Error>> {
    // Create a simple C Minor Scale on octave 4 (this requires the `composition` feature)
    let s = Scale::new(
        compute_pitch(NoteName::Do, Accidental::Natural, 4)?,
        ScaleMode::Aeolian,
    );

    // Create a phrase that just plays the scale as a sequence of quavers (half beat)
    let phrase = Phrase::from_notes_sequence(Note::new_sequence(QUAVER, MF, s.n_pitches(15)))?;

    // Create a piano part that plays the phrase from beat 0
    let mut piano_part = Part::new(Instrument::AcousticGrandPiano);
    piano_part.add_phrase(phrase, 0.);

    // Create a score with a tempo of 60 (one beat per second) and add both parts
    let mut score = Score::new("my score", Tempo::new(60)?, None);
    score.add_part(piano_part);

    // Write the score to a MIDI file for playback
    score.write_midi_file(File::create("scale_example.mid")?)?;
    Ok(())
}

pub fn pitches(&self) -> ScalePitchesIterator<'static>

Returns an iterator that iterates over all pitches in the scale once

pub fn n_pitches(&self, num_pitches: usize) -> ScalePitchesIterator<'static>

Returns an iterator that iterates over all pitches in the scale and can continue on the next octaves until length pitches have been issued or the pitch has reached a value too high for MIDI.

Examples found in repository

examples/scales_example.rs (line 19)

fn main() -> Result<(), Box<dyn Error>> {
    // Create a simple C Minor Scale on octave 4 (this requires the `composition` feature)
    let s = Scale::new(
        compute_pitch(NoteName::Do, Accidental::Natural, 4)?,
        ScaleMode::Aeolian,
    );

    // Create a phrase that just plays the scale as a sequence of quavers (half beat)
    let phrase = Phrase::from_notes_sequence(Note::new_sequence(QUAVER, MF, s.n_pitches(15)))?;

    // Create a piano part that plays the phrase from beat 0
    let mut piano_part = Part::new(Instrument::AcousticGrandPiano);
    piano_part.add_phrase(phrase, 0.);

    // Create a score with a tempo of 60 (one beat per second) and add both parts
    let mut score = Score::new("my score", Tempo::new(60)?, None);
    score.add_part(piano_part);

    // Write the score to a MIDI file for playback
    score.write_midi_file(File::create("scale_example.mid")?)?;
    Ok(())
}

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

Returns the “default value” for a type.

impl PartialEq for Scale

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Scale

impl Eq for Scale

impl StructuralPartialEq for Scale