Enum Intervals

#[repr(u8)]
pub enum Intervals {
    Semitone = 1,
    Tone = 2,
    Thirds(Third),
    Fourths(Fourth),
    Fifths(Fifth),
    Sevenths(Seventh),
    Octave = 12,
}

Intervals enumerates the various intervals used within music theory. The system considers a semitone to be the smallest interval, while the octave describe the maximum distance between any two pitches.

Variants

Semitone = 1

Tone = 2

Thirds(Third)

Fourths(Fourth)

Fifths(Fifth)

Sevenths(Seventh)

Octave = 12

Implementations

impl Intervals

pub const fn is_semitone(&self) -> bool

Returns true if the enum is Intervals::Semitone otherwise false

pub const fn is_tone(&self) -> bool

Returns true if the enum is Intervals::Tone otherwise false

pub const fn is_thirds(&self) -> bool

Returns true if the enum is Intervals::Thirds otherwise false

pub const fn is_fourths(&self) -> bool

Returns true if the enum is Intervals::Fourths otherwise false

pub const fn is_fifths(&self) -> bool

Returns true if the enum is Intervals::Fifths otherwise false

pub const fn is_sevenths(&self) -> bool

Returns true if the enum is Intervals::Sevenths otherwise false

pub const fn is_octave(&self) -> bool

Returns true if the enum is Intervals::Octave otherwise false

impl Intervals

pub fn dist(a: impl IntoPitch, b: impl IntoPitch) -> Self

pub fn new<A, B, C>(lhs: A, rhs: B) -> Self

where A: Sub<B, Output = C>, C: Into<Intervals>,

pub fn from_value(value: impl IntoPitch) -> Self

Use the difference between two pitches to determine the interval.

pub fn octave() -> Self

A convenience method for constructing a new instance of the Octave variant.

pub fn semitone() -> Self

A convenience method for constructing a new instance of the Semitone variant.

pub fn tone() -> Self

A convenience method for constructing a new instance of the Tone variant.

pub fn third(third: Third) -> Self

A convenience method for constructing a new variant, Thirds.

pub fn major_third() -> Self

pub fn minor_third() -> Self

pub fn fourth(fourth: Fourth) -> Self

A convenience method for constructing a new variant, Fourths.

pub fn perfect_fourth() -> Self

pub fn fifth(fifth: Fifth) -> Self

A convenience method for constructing a new variant, Fifths.

pub fn augmented_fifth() -> Self

pub fn diminished_fifth() -> Self

pub fn perfect_fifth() -> Self

pub fn seventh(seventh: Seventh) -> Self

A convenience method for constructing a new variant, Sevenths.

pub fn augmented_seventh() -> Self

pub fn diminished_seventh() -> Self

pub fn major_seventh() -> Self

pub fn minor_seventh() -> Self

pub fn as_pitch(&self) -> Pitch

Interpret the current interval as a pitch.

pub fn name(&self) -> &str

Returns the name of the selected interval.

pub fn value(&self) -> i8

Returns the value of the selected interval.

Trait Implementations

impl<'a> Add<&'a Note> for &'a Intervals

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: &'a Note) -> Self::Output

Performs the + operation.

impl<'a> Add<&'a Note> for Intervals

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: &'a Note) -> Self::Output

Performs the + operation.

impl<'a> Add<Intervals> for &'a Note

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: Intervals) -> Self::Output

Performs the + operation.

impl Add<Intervals> for Note

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: Intervals) -> Self::Output

Performs the + operation.

impl<'a> Add<Note> for &'a Intervals

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: Note) -> Self::Output

Performs the + operation.

impl Add<Note> for Intervals

type Output = Note

The resulting type after applying the + operator.

fn add(self, rhs: Note) -> Self::Output

Performs the + operation.

impl AddAssign<Intervals> for Note

fn add_assign(&mut self, rhs: Intervals)

Performs the += operation.

impl AsRef<str> for Intervals

fn as_ref(&self) -> &str

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

impl Clone for Intervals

fn clone(&self) -> Intervals

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Intervals

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

Formats the value using the given formatter.

impl Default for Intervals

fn default() -> Intervals

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Intervals

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Intervals

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

Formats the value using the given formatter.

impl<'a> Div<&'a Note> for &'a Intervals

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: &'a Note) -> Self::Output

Performs the / operation.

impl<'a> Div<&'a Note> for Intervals

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: &'a Note) -> Self::Output

Performs the / operation.

impl<'a> Div<Intervals> for &'a Note

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: Intervals) -> Self::Output

Performs the / operation.

impl Div<Intervals> for Note

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: Intervals) -> Self::Output

Performs the / operation.

impl<'a> Div<Note> for &'a Intervals

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: Note) -> Self::Output

Performs the / operation.

impl Div<Note> for Intervals

type Output = Note

The resulting type after applying the / operator.

fn div(self, rhs: Note) -> Self::Output

Performs the / operation.

impl DivAssign<Intervals> for Note

fn div_assign(&mut self, rhs: Intervals)

Performs the /= operation.

impl From<Fifth> for Intervals

fn from(value: Fifth) -> Self

Converts to this type from the input type.

impl From<Fourth> for Intervals

fn from(value: Fourth) -> Self

Converts to this type from the input type.

impl<P> From<P> for Intervals

where P: IntoPitch,

fn from(value: P) -> Self

Converts to this type from the input type.

impl From<Seventh> for Intervals

fn from(value: Seventh) -> Self

Converts to this type from the input type.

impl From<Third> for Intervals

fn from(value: Third) -> Self

Converts to this type from the input type.

impl Hash for Intervals

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 IntervalKind for Intervals

fn value(&self) -> i8

Returns the value associated with the interval

fn kind(&self) -> Intervals

Returns the interval associated with the value

impl<'a> Mul<&'a Note> for &'a Intervals

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Note) -> Self::Output

Performs the * operation.

impl<'a> Mul<&'a Note> for Intervals

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: &'a Note) -> Self::Output

Performs the * operation.

impl<'a> Mul<Intervals> for &'a Note

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: Intervals) -> Self::Output

Performs the * operation.

impl Mul<Intervals> for Note

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: Intervals) -> Self::Output

Performs the * operation.

impl<'a> Mul<Note> for &'a Intervals

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: Note) -> Self::Output

Performs the * operation.

impl Mul<Note> for Intervals

type Output = Note

The resulting type after applying the * operator.

fn mul(self, rhs: Note) -> Self::Output

Performs the * operation.

impl MulAssign<Intervals> for Note

fn mul_assign(&mut self, rhs: Intervals)

Performs the *= operation.

impl Ord for Intervals

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

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

fn partial_cmp(&self, other: &Intervals) -> 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<'a> Rem<&'a Note> for &'a Intervals

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Note) -> Self::Output

Performs the % operation.

impl<'a> Rem<&'a Note> for Intervals

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: &'a Note) -> Self::Output

Performs the % operation.

impl<'a> Rem<Intervals> for &'a Note

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: Intervals) -> Self::Output

Performs the % operation.

impl Rem<Intervals> for Note

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: Intervals) -> Self::Output

Performs the % operation.

impl<'a> Rem<Note> for &'a Intervals

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: Note) -> Self::Output

Performs the % operation.

impl Rem<Note> for Intervals

type Output = Note

The resulting type after applying the % operator.

fn rem(self, rhs: Note) -> Self::Output

Performs the % operation.

impl RemAssign<Intervals> for Note

fn rem_assign(&mut self, rhs: Intervals)

Performs the %= operation.

impl Serialize for Intervals

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Sub<&'a Note> for &'a Intervals

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Note) -> Self::Output

Performs the - operation.

impl<'a> Sub<&'a Note> for Intervals

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: &'a Note) -> Self::Output

Performs the - operation.

impl<'a> Sub<Intervals> for &'a Note

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: Intervals) -> Self::Output

Performs the - operation.

impl Sub<Intervals> for Note

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: Intervals) -> Self::Output

Performs the - operation.

impl<'a> Sub<Note> for &'a Intervals

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: Note) -> Self::Output

Performs the - operation.

impl Sub<Note> for Intervals

type Output = Note

The resulting type after applying the - operator.

fn sub(self, rhs: Note) -> Self::Output

Performs the - operation.

impl SubAssign<Intervals> for Note

fn sub_assign(&mut self, rhs: Intervals)

Performs the -= operation.

impl Copy for Intervals

impl Eq for Intervals

impl StructuralPartialEq for Intervals