Struct ukebox::chord::Chord

pub struct Chord {
    pub root: Note,
    pub chord_type: ChordType,
}

A chord such as C, Cm and so on.

Fields

root: Note

chord_type: ChordType

Implementations

impl Chord

pub fn new(root: Note, chord_type: ChordType) -> Self

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

Return an iterator over the chord’s notes.

pub fn voicings(
    &self,
    config: VoicingConfig
) -> impl Iterator<Item = Voicing> + '_

pub fn transpose(&self, semitones: i8) -> Chord

Trait Implementations

impl Add<u8> for Chord

type Output = Self

The resulting type after applying the + operator.

fn add(self, n: Semitones) -> Self

Performs the + operation.

impl Clone for Chord

fn clone(&self) -> Chord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Chord

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

Formats the value using the given formatter.

impl Display for Chord

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

Formats the value using the given formatter.

impl FromStr for Chord

type Err = ParseChordError

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 Chord

fn cmp(&self, other: &Chord) -> 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<Chord> for Chord

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

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

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

This method tests for !=.

impl PartialOrd<Chord> for Chord

fn partial_cmp(&self, other: &Chord) -> 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 Sub<u8> for Chord

type Output = Self

The resulting type after applying the - operator.

fn sub(self, n: Semitones) -> Self

Performs the - operation.

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

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

Determine the chord that is represented by a list of pitch classes.

type Error = &'static str

The type returned in the event of a conversion error.

impl Copy for Chord

impl Eq for Chord

impl StructuralEq for Chord

impl StructuralPartialEq for Chord