Enum ukebox::chord_type::ChordType

pub enum ChordType {
    Major,
    Minor,
    SuspendedSecond,
    SuspendedFourth,
    Augmented,
    Diminished,
    DominantSeventh,
    MinorSeventh,
    MajorSeventh,
    MinorMajorSeventh,
    AugmentedSeventh,
    AugmentedMajorSeventh,
    DiminishedSeventh,
    HalfDiminishedSeventh,
}

The type of the chord depending on the intervals it contains.

Variants

Major

Minor

SuspendedSecond

SuspendedFourth

Augmented

Diminished

DominantSeventh

MinorSeventh

MajorSeventh

MinorMajorSeventh

AugmentedSeventh

AugmentedMajorSeventh

DiminishedSeventh

HalfDiminishedSeventh

Implementations

impl ChordType

pub fn intervals(&self) -> impl Iterator<Item = Interval> + '_

Return an iterator over the chord type’s intervals.

pub fn to_symbol(self) -> String

Trait Implementations

impl Clone for ChordType

fn clone(&self) -> ChordType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChordType

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

Formats the value using the given formatter.

impl Display for ChordType

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

Formats the value using the given formatter.

impl FromStr for ChordType

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Ord for ChordType

fn cmp(&self, other: &ChordType) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ChordType> for ChordType

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialOrd<ChordType> for ChordType

fn partial_cmp(&self, other: &ChordType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<&'_ [PitchClass]> for ChordType

fn try_from(pitches: &[PitchClass]) -> Result<Self, Self::Error>

Determine the chord type from a list of pitch classes representing a chord.

type Error = &'static str

The type returned in the event of a conversion error.

impl Copy for ChordType

impl Eq for ChordType

impl StructuralEq for ChordType

impl StructuralPartialEq for ChordType