Enum HarmonicFunction

pub enum HarmonicFunction {
    Ambiguous,
    Dominant,
    LeadingTone,
    Mediant,
    Predominant,
    Secondary,
    Subdominant,
    Submediant,
    Supertonic,
    Tonic,
}

Harmonic functions in tonal music

Variants

Ambiguous

Dominant

LeadingTone

Mediant

Predominant

Secondary

Subdominant

Submediant

Supertonic

Tonic

Implementations

impl HarmonicFunction

pub fn ambiguous() -> Self

pub fn dominant() -> Self

pub fn leading_tone() -> Self

pub fn mediant() -> Self

pub fn predominant() -> Self

pub fn secondary() -> Self

pub fn subdominant() -> Self

pub fn submediant() -> Self

pub fn supertonic() -> Self

pub fn tonic() -> Self

impl HarmonicFunction

pub const fn is_ambiguous(&self) -> bool

Returns true if the enum is HarmonicFunction::Ambiguous otherwise false

pub const fn is_dominant(&self) -> bool

Returns true if the enum is HarmonicFunction::Dominant otherwise false

pub const fn is_leading_tone(&self) -> bool

Returns true if the enum is HarmonicFunction::LeadingTone otherwise false

pub const fn is_mediant(&self) -> bool

Returns true if the enum is HarmonicFunction::Mediant otherwise false

pub const fn is_predominant(&self) -> bool

Returns true if the enum is HarmonicFunction::Predominant otherwise false

pub const fn is_secondary(&self) -> bool

Returns true if the enum is HarmonicFunction::Secondary otherwise false

pub const fn is_subdominant(&self) -> bool

Returns true if the enum is HarmonicFunction::Subdominant otherwise false

pub const fn is_submediant(&self) -> bool

Returns true if the enum is HarmonicFunction::Submediant otherwise false

pub const fn is_supertonic(&self) -> bool

Returns true if the enum is HarmonicFunction::Supertonic otherwise false

pub const fn is_tonic(&self) -> bool

Returns true if the enum is HarmonicFunction::Tonic otherwise false

Trait Implementations

impl AsRef<str> for HarmonicFunction

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for HarmonicFunction

fn clone(&self) -> HarmonicFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HarmonicFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HarmonicFunction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HarmonicFunction

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

Formats the value using the given formatter.

impl EnumCount for HarmonicFunction

const COUNT: usize = 10usize

impl FromStr for HarmonicFunction

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for HarmonicFunction

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for HarmonicFunction

type Iterator = HarmonicFunctionIter

fn iter() -> HarmonicFunctionIter

impl Ord for HarmonicFunction

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HarmonicFunction

fn eq(&self, other: &HarmonicFunction) -> 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 PartialOrd for HarmonicFunction

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for HarmonicFunction

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 HarmonicFunction

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<HarmonicFunction, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl VariantArray for HarmonicFunction

const VARIANTS: &'static [Self]

impl VariantNames for HarmonicFunction

const VARIANTS: &'static [&'static str]

Names of the variants of this enum

impl Copy for HarmonicFunction

impl Eq for HarmonicFunction

impl StructuralPartialEq for HarmonicFunction