Enum musictheory::types::Accidental

pub enum Accidental {
    DoubleFlat,
    Flat,
    Natural,
    Sharp,
    DoubleSharp,
}

Accidentals describe if a Note is natural, sharp or flat.

Variants

DoubleFlat

Flat

Natural

Sharp

DoubleSharp

Methods

impl Accidental

pub fn sharp(&self) -> bool

True if a Note is sharp or double sharp.

pub fn flat(&self) -> bool

True if a Note is flat or double flat.

pub fn natural(&self) -> bool

True if a Note is natural.

Trait Implementations

impl Clone for Accidental

fn clone(&self) -> Accidental

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Accidental

impl Debug for Accidental

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

Formats the value using the given formatter.

impl Display for Accidental

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

Formats the value using the given formatter.

impl Eq for Accidental

impl Ord for Accidental

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Accidental> for Accidental

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

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

impl StructuralPartialEq for Accidental