Struct Alterations 

pub struct Alterations {
    pub no: No,
    pub seventh: Seventh,
    pub slash: Option<Note>,
    /* private fields */
}

Represents a list of all the alterations presented in a chord.

This struct provides a simple and intuitive way to add alterations using the safe included methods.

Fields

no: No

Represents an omitted tone in the

seventh: Seventh

Represents a seventh in the chord

slash: Option<Note>

Represents the bass note override (slash chord)

Implementations

impl Alterations

pub fn new() -> Self

Creates a new empty instance of Alterations.

Examples

use chord_parser::chord::*;
 
let mut alterations = Alterations::new();
 
// Do whatever
alterations.set_suspension(&AlteredInterval::Fourth);

pub fn alters(&self) -> &Vec<ChordAlter>

Returns a list of all the added alterations.

Examples

use chord_parser::chord::*;
 
let mut alterations = Alterations::new();
 
alterations.set_note(&ChordNoteAlter {
    interval: AlteredInterval::Ninth,
    accidental: Accidental::Sharp,
});
 
alterations.set_suspension(&AlteredInterval::Fourth);
 
alterations.alters(); // Returns the added ninth and suspended fourth

pub fn get_note(&self, interval: &AlteredInterval) -> Option<&ChordNoteAlter>

Tries to get a note alteration associated with the passed interval.

Examples

use chord_parser::chord::*;
 
let mut alterations = Alterations::new();
 
alterations.set_note(&ChordNoteAlter {
    interval: AlteredInterval::Ninth,
    accidental: Accidental::Sharp,
});
 
alterations.get_note(&AlteredInterval::Ninth); // Returns the interval and accidental

pub fn get_accidental(&self, interval: &AlteredInterval) -> Option<Accidental>

Tries to get the accidental altered for an interval.

Examples

use chord_parser::chord::*;
 
let mut alterations = Alterations::new();
 
alterations.set_note(&ChordNoteAlter {
    interval: AlteredInterval::Ninth,
    accidental: Accidental::Sharp,
});
 
alterations.get_accidental(&AlteredInterval::Ninth); // Returns Accidental::Sharp

pub fn set_note(&mut self, alter: &ChordNoteAlter)

Set a new alteration for an interval.

If an alteration for the interval already exists, the accidental will be overwritten. If it doesn’t exist, a new alteration is added.

Examples

use chord_parser::chord::*;
 
let mut alterations = Alterations::new();
 
alterations.set_note(&ChordNoteAlter {
    interval: AlteredInterval::Ninth,
    accidental: Accidental::Sharp,
});
 
// Now the 9th is flatten
alterations.set_note(&ChordNoteAlter {
    interval: AlteredInterval::Ninth,
    accidental: Accidental::Flat,
});
 
alterations.set_note(&ChordNoteAlter {
    interval: AlteredInterval::Eleventh,
    accidental: Accidental::Sharp,
});
 
// Get back all the 2 alterations added
alterations.alters();

pub fn get_suspension(&self) -> Option<&AlteredInterval>

Tries to get the suspended note alteration in the chord

Examples

use chord_parser::chord::*;
 
let mut alterations = Alterations::new();
 
alterations.set_suspension(&AlteredInterval::Fourth);
alterations.get_suspension(); // Returns Some(&AlteredInterval::Fourth)

pub fn set_suspension(&mut self, interval: &AlteredInterval)

Set the new suspended interval.

Old suspended interval will be replaced with the new one, if the old interval is present.

Examples

use chord_parser::chord::*;
 
let mut alterations = Alterations::new();
 
alterations.set_suspension(&AlteredInterval::Second);
alterations.get_suspension(); // Returns Some(&AlteredInterval::Second)

Trait Implementations

impl Clone for Alterations

fn clone(&self) -> Alterations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Alterations

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

Formats the value using the given formatter.

impl PartialEq for Alterations

fn eq(&self, other: &Alterations) -> 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 ToString for Alterations

fn to_string(&self) -> String

Converts the given value to a String.

impl Eq for Alterations

impl StructuralPartialEq for Alterations