Enum IntervalQuality

#[non_exhaustive]
pub enum IntervalQuality {
    Augmented(PhantomData<Augmented>),
    Diminished(PhantomData<Diminished>),
    Major(PhantomData<Major>),
    Minor(PhantomData<Minor>),
    Perfect(PhantomData<Perfect>),
}

This enum provides a more streamlined means of working with the implemented Quality types. Primarily, it provides simple creation routines for otherwise unitializable types.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Augmented(PhantomData<Augmented>)

Diminished(PhantomData<Diminished>)

Major(PhantomData<Major>)

Minor(PhantomData<Minor>)

Perfect(PhantomData<Perfect>)

Implementations

impl IntervalQuality

pub const fn is_augmented(&self) -> bool

Returns true if the enum is IntervalQuality::Augmented otherwise false

pub const fn is_diminished(&self) -> bool

Returns true if the enum is IntervalQuality::Diminished otherwise false

pub const fn is_major(&self) -> bool

Returns true if the enum is IntervalQuality::Major otherwise false

pub const fn is_minor(&self) -> bool

Returns true if the enum is IntervalQuality::Minor otherwise false

pub const fn is_perfect(&self) -> bool

Returns true if the enum is IntervalQuality::Perfect otherwise false

impl IntervalQuality

pub fn new<Q: Quality>() -> Self

pub fn augmented() -> Self

pub fn diminished() -> Self

pub fn major() -> Self

pub fn minor() -> Self

pub fn perfect() -> Self

pub fn from_str(value: &str) -> Option<Self>

Trait Implementations

impl AsRef<str> for IntervalQuality

fn as_ref(&self) -> &str

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

impl Clone for IntervalQuality

fn clone(&self) -> IntervalQuality

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IntervalQuality

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IntervalQuality

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IntervalQuality

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

Formats the value using the given formatter.

impl EnumCount for IntervalQuality

const COUNT: usize = 5usize

impl FromStr for IntervalQuality

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for IntervalQuality

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 IntervalQuality

type Iterator = IntervalQualityIter

fn iter() -> IntervalQualityIter

impl Ord for IntervalQuality

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

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

fn partial_cmp(&self, other: &IntervalQuality) -> 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 IntervalQuality

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 IntervalQuality

type Error = ParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl VariantNames for IntervalQuality

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

Names of the variants of this enum

impl Copy for IntervalQuality

impl Eq for IntervalQuality

impl StructuralPartialEq for IntervalQuality