Enum music_theory::theory::interval::NamedOctaveInterval

pub enum NamedOctaveInterval {
    Root,
    Min2,
    Maj2,
    Min3,
    Maj3,
    Per4,
    Trit,
    Per5,
    Min6,
    Maj6,
    Min7,
    Maj7,
}

An interval within the octave with a distinct name.

Variants

Root

The root interval is an interval of zero.

Min2

Minor second interval.

Maj2

Major second interval.

Min3

Minor third interval.

Maj3

Major third interval.

Per4

Perfect fourth interval.

Trit

Tritone interval.

Per5

Perfect fifth interval.

Min6

Minor sixth interval.

Maj6

Major sixth interval.

Min7

Minor seventh interval.

Maj7

Major seventh interval.

Implementations

impl NamedOctaveInterval

pub const ALL: [Self; 12] = _

All named octave intervals so you iterate over them.

Example:

use music_theory::theory::*;
assert_eq!(NamedOctaveInterval::ALL.iter().copied().next(), Some(NamedOctaveInterval::Root));

Trait Implementations

impl Clone for NamedOctaveInterval

fn clone(&self) -> NamedOctaveInterval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Cyclic for NamedOctaveInterval

fn next(self) -> Self

Generate the next item.

fn prev(self) -> Self

Generate the previous item.

impl Debug for NamedOctaveInterval

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

Formats the value using the given formatter.

impl Display for NamedOctaveInterval

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

Formats the value using the given formatter.

impl Hash for NamedOctaveInterval

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 Ord for NamedOctaveInterval

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<NamedOctaveInterval> for NamedOctaveInterval

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<NamedOctaveInterval> for NamedOctaveInterval

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

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

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

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

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

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

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

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

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 ToInterval for NamedOctaveInterval

fn to_interval(self) -> Interval

Take self and return Interval.

impl Copy for NamedOctaveInterval

impl Eq for NamedOctaveInterval

impl StructuralEq for NamedOctaveInterval

impl StructuralPartialEq for NamedOctaveInterval