Struct ChordSymbolFigure 

pub struct ChordSymbolFigure {
    pub root: String,
    pub kind: &'static str,
    pub abbreviation: &'static str,
    pub bass: Option<String>,
    pub additions: Vec<String>,
    pub omissions: Vec<String>,
}

A chord named as a lead-sheet symbol, in the parts music21’s chordSymbolFigureFromChord writes it from: the root, the kind and its abbreviation, the bass where it is not the root, and the notes the kind does not account for.

Display writes the figure as music21 writes it — C7, E-m7/G-, CaddD- — and Self::written_with writes it with another abbreviation for the kind.

Fields

root: String

The root the figure is written on.

A suspended second in inversion is read as a suspended fourth on its bass, as music21 reads it, so for that chord this is the bass.

kind: &'static str

music21’s name for the kind, dominant-seventh.

abbreviation: &'static str

The abbreviation music21 writes the kind with, 7.

bass: Option<String>

The bass, where it is not the root.

additions: Vec<String>

The notes of the chord the kind does not account for.

omissions: Vec<String>

The notes the kind expects that the chord lacks. music21 writes these only beside additions: a chord that leaves out a note of its kind is still that kind, and says nothing about it.

Implementations

impl ChordSymbolFigure

pub fn from_chord(chord: &Chord) -> Option<Self>

The figure of a chord, or None for an empty chord, a microtonal one, or one no kind in music21’s table fits.

pub fn from_chord_with_root(chord: &Chord, root: &Pitch) -> Option<Self>

The figure with the root fixed by the caller rather than inferred, which is how music21 names the augmented sixths.

pub fn written_with(&self, abbreviation: &str) -> String

The figure written with another abbreviation for its kind, which is how music21 writes it after changeAbbreviationFor.

Trait Implementations

impl Clone for ChordSymbolFigure

fn clone(&self) -> ChordSymbolFigure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChordSymbolFigure

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

Formats the value using the given formatter.

impl Display for ChordSymbolFigure

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

Formats the value using the given formatter.

impl Eq for ChordSymbolFigure

impl PartialEq for ChordSymbolFigure

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ChordSymbolFigure