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

pub use name::NoteName::{self, *};
pub use accidental::Accidental::{self, *};
pub use crate::{
    nope,
    error::{
        NoteError::{self, *},
        ResonataError}
};

pub mod name;
pub mod accidental;
pub mod macros;
mod utils;
mod tests;

#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub struct Note {
    name: NoteName,
    accidental: Accidental,
}

impl Note {
    pub fn new(name: NoteName, accidental: Accidental) -> Self {
        Note { name, accidental }
    }

    pub fn from_note_name(name: NoteName) -> Self {
        Note { name, accidental: Natural }
    }
}

#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub struct PitchedNote {
    note: Note,
    octave: i8,
}

impl PitchedNote {
    pub fn new(name: NoteName, accidental: Accidental, octave: i8) -> Self {
        Self::build(Note { name, accidental }, octave)
    }

    /// Creates a new note from a note name, accidental and octave.
    /// Octave numbers outside of the range -1 to 9 will be clamped to the nearest valid number.
    pub fn build(note: Note, octave: i8) -> Self {
        let octave = std::cmp::min(std::cmp::max(octave, -1), 9);
        
        PitchedNote { 
            note,
            octave,
        }
    }

    pub fn from_note_name_and_octave(name: NoteName, octave: i8) -> Self {
        Self::build(Note { name, accidental: Natural }, octave)
    }

    /// Returns the note name of the note
    pub fn name(&self) -> NoteName {
        self.note.name
    }

    /// Returns the accidental of the note
    pub fn accidental(&self) -> Accidental {
        self.note.accidental
    }

    /// Returns the octave of the note
    pub fn octave(&self) -> i8 {
        self.octave
    }
}