resonata 0.3.0

A music theory library for Rust.
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

use std::{fmt::{self, Display, Formatter, Debug}, ops::Add, ops::{Sub, AddAssign, SubAssign}, str::FromStr};
use super::super::*;

impl From<u8> for IntervalSize {
    fn from(value: u8) -> Self {
        match value % 7 {
            0 => Unison,
            1 => Second,
            2 => Third,
            3 => Fourth,
            4 => Fifth,
            5 => Sixth,
            6 => Seventh,
            _ => unreachable!("Result should always be in the range 0..6"),
        }
    }
}

impl From<IntervalSize> for u8 {
    fn from(is: IntervalSize) -> Self {
        match is {
            Unison => 0,
            Second => 1,
            Third => 2,
            Fourth => 3,
            Fifth => 4,
            Sixth => 5,
            Seventh => 6,
        }
    }
}

impl Add<u8> for IntervalSize {
    type Output = Self;

    fn add(self, n: u8) -> Self::Output {
        Self::from(u8::from(self) + n % 7)
    }
}

impl AddAssign<u8> for IntervalSize {
    fn add_assign(&mut self, n: u8) {
        *self = Self::from(u8::from(*self) + n % 7)
    }
}

impl Sub<u8> for IntervalSize {
    type Output = Self;

    fn sub(self, n: u8) -> Self::Output {
        Self::from((u8::from(self) as i8 - n as i8).abs() as u8 % 7)
    }
}

impl SubAssign<u8> for IntervalSize {
    fn sub_assign(&mut self, n: u8) {
        *self = Self::from((u8::from(*self) as i8 - n as i8).abs() as u8 % 7)
    }
}

impl Add for IntervalSize {
    type Output = Self;

    fn add(self, other: Self) -> Self::Output {
        Self::from(u8::from(self) + u8::from(other))
    }
}

impl AddAssign for IntervalSize {
    fn add_assign(&mut self, other: Self) {
        *self = Self::from(u8::from(*self) + u8::from(other))
    }
}

impl Sub for IntervalSize {
    type Output = Self;

    fn sub(self, other: Self) -> Self::Output {
        Self::from((u8::from(self) as i8 - u8::from(other) as i8).abs() as u8)
    }
}

impl SubAssign for IntervalSize {
    fn sub_assign(&mut self, other: Self) {
        *self = Self::from((u8::from(*self) as i8 - u8::from(other) as i8).abs() as u8)
    }
}

impl FromStr for IntervalSize {
    type Err = ResonataError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        // if str is a cardinal number convert into u8 and then into IntervalSize
        if let Ok(number) = s.parse::<u8>() {
            return Ok(IntervalSize::from(number - 1))
        }

        // if str is an ordinal number, convert into u8 and then into IntervalSize
        if let Ok(number) = s
            .trim_end_matches("st")
            .trim_end_matches("nd")
            .trim_end_matches("rd")
            .trim_end_matches("th")
            .trim_end_matches("ve")
            .parse::<u8>() {
            return Ok(IntervalSize::from(number - 1))
        }
        
        // if str is a string, match against the string and return the corresponding IntervalSize
        match s.to_lowercase().as_str() {
            "unison" | "u" => Ok(Unison),
            "second" => Ok(Second),
            "third" => Ok(Third),
            "fourth" => Ok(Fourth),
            "fifth" => Ok(Fifth),
            "sixth" => Ok(Sixth),
            "seventh" => Ok(Seventh),
            _ => nope!(InvalidIntervalSize)
        }
    }
}

impl Display for IntervalSize {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        // let number = *self as u8 + (octaves * 7);
        // match number {
        //     1 => "U".to_string(),
        //     8 => "8ve".to_string(),
        //     _ => {
        //         let suffix = match number % 10 {
        //             1 => "st",
        //             2 => "nd",
        //             3 => "rd",
        //             _ => "th",
        //         };
        //         format!("{}{}", number, suffix)
        //     }
        // }
        match self {
            Unison => write!(f, "U"),
            Second => write!(f, "2"),
            Third => write!(f, "3"),
            Fourth => write!(f, "4"),
            Fifth => write!(f, "5"),
            Sixth => write!(f, "6"),
            Seventh => write!(f, "7"),
        }
    }
}

impl Debug for IntervalSize {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.to_string())
    }
}