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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

/*
    Appellation: signs <module>
    Contrib: FL03 <jo3mccain@icloud.com>
*/
use crate::Error;

#[derive(
    Clone,
    Copy,
    Debug,
    Default,
    Eq,
    Hash,
    Ord,
    PartialEq,
    PartialOrd,
    strum::AsRefStr,
    strum::Display,
)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]

pub enum SymbolCount {
    Double = 2,
    #[default]
    Single = 1,
}
pub struct FlatSymbol(pub SymbolCount);

pub struct SharpSym(pub SymbolCount);

pub enum Sign {
    Flat(FlatSymbol),
    Sharp(SharpSym),
}

impl SharpSym {
    pub const REPR: char = '#';
    pub const SYMBOLS: [&'static str; 6] = ["♯", "♯♯", "s", "S", "ss", "SS"];

    pub fn symbol(&self) -> &str {
        match self.0 {
            SymbolCount::Double => Self::SYMBOLS[1],
            SymbolCount::Single => Self::SYMBOLS[0],
        }
    }
}

impl FlatSymbol {
    pub const REPR: char = '♭';
    pub const SYMBOLS: [&'static str; 8] = ["♭", "♭♭", "b", "bb", "f", "ff", "F", "FF"];

    pub fn symbol(&self) -> &str {
        match self.0 {
            SymbolCount::Double => Self::SYMBOLS[1],
            SymbolCount::Single => Self::SYMBOLS[0],
        }
    }
}

impl Sign {
    pub fn symbol(&self) -> &str {
        match self {
            Sign::Flat(flat) => flat.symbol(),
            Sign::Sharp(sharp) => sharp.symbol(),
        }
    }
}

impl core::str::FromStr for SharpSym {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "♯" | "s" | "S" => Ok(Self(SymbolCount::Single)),
            "♯♯" | "ss" | "SS" => Ok(Self(SymbolCount::Double)),
            _ => Err(Error::parse_error(
                "No accepted representation of the sharp symbol was found.",
            )),
        }
    }
}

impl core::str::FromStr for FlatSymbol {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "♭" | "b" | "f" | "F" => Ok(Self(SymbolCount::Single)),
            "♭♭" | "bb" | "ff" | "FF" => Ok(Self(SymbolCount::Double)),
            _ => Err(Error::parse_error(
                "No accepted representation of the flat symbol was found.",
            )),
        }
    }
}