rstmt-core 0.0.2

This crate focuses on building a music theory library that can be used to generate music theory data structures and algorithms.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

/*
    Appellation: intervals <module>
    Contrib: FL03 <jo3mccain@icloud.com>
*/
#[doc(inline)]
pub use self::kinds::*;

pub(crate) mod kinds;

#[doc(hidden)]
pub mod qualities;

pub(crate) mod prelude {
    pub use super::kinds::*;
    pub use super::IntervalKind;
}

pub(crate) type IntervalTy = i8;

pub trait MusicalInterval {
    fn as_i8(&self) -> i8;
}

/// [IntoInterval] is a trait describing a method which consumes the current type,
/// converting it into an [Intervals]
pub trait IntoInterval {
    fn into_interval(self) -> Intervals;
}

/// [IntervalKind] denotes objects used to explicitly define the various
/// intervals in music theory.
pub trait IntervalKind {
    private!();
    /// Returns the interval associated with the value
    fn kind(&self) -> Intervals {
        Intervals::from_value(self.value())
    }
    /// Returns the value associated with the interval
    fn value(&self) -> IntervalTy;
}

/*
 ************* Implementations *************
*/

impl<I> IntoInterval for I
where
    I: Into<Intervals>,
{
    fn into_interval(self) -> Intervals {
        self.into()
    }
}

impl IntervalKind for Intervals {
    seal!();
    fn value(&self) -> IntervalTy {
        self.value()
    }
}