Struct ChordSymbol 

pub struct ChordSymbol { /* private fields */ }

Parsed chord symbol.

Implementations

impl ChordSymbol

pub fn parse(figure: impl Into<String>) -> Result<Self>

Parses a chord symbol such as "Cmaj7", "F#m7b5", or "Bb7#11".

pub fn kind(&self) -> Option<&str>

music21’s chordKind: the kind the shorthand names, where it is one of music21’s abbreviations, so Cmaj7 is major-seventh and CN6 the Neapolitan. None for a shorthand the crate reads on its own.

pub fn figure(&self) -> &str

Returns the original chord-symbol figure.

pub fn root(&self) -> &Pitch

Returns the root pitch.

pub fn bass(&self) -> Option<&Pitch>

Returns the slash bass pitch, if one was supplied.

pub fn quality(&self) -> ChordQuality

Returns the parsed chord quality.

pub fn extensions(&self) -> &[u8]

Returns parsed extension degrees.

pub fn alterations(&self) -> &[ChordAlteration]

Returns parsed alterations.

pub fn omissions(&self) -> &[u8]

Returns degrees omitted with no... or omit... markers.

pub fn additions(&self) -> &[ChordAlteration]

Returns parsed added tones from add(...) groups.

pub fn find_figure(&self) -> String

Rebuilds the figure from the parsed parts in one canonical spelling: music21’s findFigure. Whatever was typed, a half-diminished seventh comes back as m7b5, an augmented triad as aug, an added ninth as add(9), and the result parses back to the same chord.

pub fn transpose(&self, interval: &Interval) -> Result<ChordSymbol>

The same chord on a transposed root and bass, its figure rebuilt by Self::find_figure: music21’s transpose, so B-/D up a major second is C/E.

pub fn inversion_is_valid(&self, inversion: u8) -> bool

Whether the chord has enough members for the given inversion: music21’s inversionIsValid, so first and second inversions always are, a third needs a seventh, a fourth a ninth and a fifth an eleventh or thirteenth. Root position is not an inversion.

pub fn to_chord(&self) -> Result<Chord>

Realizes the symbol as a chord. An eleventh implies the ninth and a thirteenth implies the ninth and eleventh, as music21’s chord kinds spell them, unless the figure omits them.

Trait Implementations

impl Clone for ChordSymbol

fn clone(&self) -> ChordSymbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChordSymbol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChordSymbol

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for ChordSymbol

type Err = Error

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq for ChordSymbol

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ChordSymbol

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChordSymbol

impl TryFrom<&str> for ChordSymbol

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for ChordSymbol

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.