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 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 to_chord(&self) -> Result<Chord>

Realizes the chord symbol as a Chord.

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

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

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 Serialize for ChordSymbol

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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.

impl StructuralPartialEq for ChordSymbol