Struct Harte 

pub struct Harte { /* private fields */ }

A chord read from a Harte label, with the Chord it sounds.

The chord’s pitches stand in degree order above the root in octave 4, the bass an octave lower where it is not the root, and the root and bass are fixed on the chord as the label names them. A label of N or X is no chord at all: it has no root and an empty chord.

Two labels are equal when they sound the same chord: the same root, the same degrees once the shorthand is unwrapped, and the same bass. C:maj equals C:(3,5).

Implementations

impl Harte

pub fn new(label: &str) -> Result<Self>

Reads a label and builds the chord it names.

pub fn label(&self) -> &str

The label as it was given.

pub fn is_empty(&self) -> bool

Whether the label names no chord, N or X.

pub fn chord(&self) -> &Chord

The chord the label sounds.

pub fn into_chord(self) -> Chord

The chord, handed over.

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

The root as written, Bb; harte-library’s get_root.

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

The bass as a degree above the root, 1 when none was written; harte-library’s get_bass.

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

The shorthand, where the label carries one; harte-library’s get_shorthand.

pub fn degrees(&self) -> Option<&[String]>

The degrees written in parentheses, *3 included, or None when there were none; harte-library’s get_degrees.

pub fn unwrap_shorthand(&self) -> Option<&[String]>

Every degree the chord sounds, the shorthand’s and the written ones together with the root and the bass, in order; harte-library’s unwrap_shorthand, which answers the written degrees alone for a label with no shorthand and nothing for one with neither.

pub fn sounding_degrees(&self) -> &[String]

Every degree the chord sounds, the root and the bass among them, in order; empty for no chord.

pub fn bass_is_root(&self) -> bool

Whether the bass is the root.

pub fn contains_shorthand(&self) -> bool

Whether the label carries a shorthand.

pub fn midi_pitches(&self) -> Vec<IntegerType>

The MIDI numbers of the pitches, lowest first.

pub fn multi_hot_encoding(&self, transpose: bool) -> [u8; 12]

Which of the twelve pitch classes the chord sounds, one flag each, counted from C, or from the root with transpose.

pub fn prettify(&self) -> String

The label rewritten with the largest shorthand its degrees contain, the degrees left over in parentheses and the bass after a slash: C:(b3,5) is C:min. A label whose degrees fit no shorthand comes back as it was written; so does N.

Trait Implementations

impl Clone for Harte

fn clone(&self) -> Harte

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Harte

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Harte

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 Display for Harte

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

The label in its canonical spelling: root, shorthand, degrees and bass, without spaces; N for no chord.

impl FromStr for Harte

type Err = Error

The associated error which can be returned from parsing.

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

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

impl PartialEq for Harte

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Harte

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.