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

/*
    Appellation: pitches <module>
    Contrib: FL03 <jo3mccain@icloud.com>
*/
#[doc(inline)]
pub use self::{kinds::*, pitch::Pitch};

pub(crate) mod kinds;
pub(crate) mod pitch;

#[doc(hidden)]
pub mod signs;

mod impls {
    mod pitch_ops;
}

pub(crate) mod prelude {
    pub use super::kinds::{Flat, Natural, Pitches, Sharp};
    pub use super::pitch::Pitch;
    pub use super::{IntoPitch, PitchClass, PitchTy};
}

lazy_static::lazy_static! {
    static ref FLAT_SYMBOLS: [char; 3] = ['♭', 'f', 'F'];
    static ref SHARP_SYMBOLS: [char; 3] = ['#', 's', 'S'];
}
/// A type alias for an integer representing a particular pitch of a note
pub type PitchTy = i8;
/// A trait for converting a type into a [Pitch](Pitch) instance.
pub trait IntoPitch {
    fn into_pitch(self) -> Pitch;
}
/// Used to denote a particular pitch class; pitch classes are symbolic
/// representations of pre-defined frequencies.
pub trait PitchClass {
    private!();

    fn pitch(&self) -> PitchTy;
}

/*
 ************* Implementations *************
*/
impl<S> IntoPitch for S
where
    S: Into<Pitch>,
{
    fn into_pitch(self) -> Pitch {
        self.into()
    }
}