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

use thiserror::Error;

pub use IntervalError::*;
pub use NoteError::*;
pub use ScaleError::*;

#[derive(Error, Debug, PartialEq, Eq)]
pub enum IntervalError {
    #[error("Invalid interval")]
    InvalidInterval,
    #[error("Invalid interval quality")]
    InvalidIntervalQuality,
    #[error("Invalid diminished count")]
    InvalidDiminishedCount,
    #[error("Invalid augmented count")]
    InvalidAugmentedCount,
    #[error("Invalid interval size")]
    InvalidIntervalSize,
    #[error("Invalid interval format")]
    InvalidIntervalFormat,
}

#[derive(Error, Debug, PartialEq, Eq)]
pub enum NoteError {
    #[error("Invalid note")]
    InvalidNote,
    #[error("Invalid note name")]
    InvalidNoteName,
    #[error("Invalid accidental")]
    InvalidAccidental,
    #[error("Invalid accidental combination")]
    InvalidAccidentalCombination,
    #[error("Invalid octave")]
    InvalidOctave,
}

#[derive(Error, Debug, PartialEq, Eq)]
pub enum ScaleError {
    #[error("Invalid scale")]
    InvalidScale,
    #[error("Invalid scale format")]
    NoRootSpecified,
}

#[derive(Error, Debug, PartialEq, Eq)]
pub enum ResonataError {
    #[error("Note error: {0}")]
    NoteError(#[from] NoteError),
    #[error("Interval error: {0}")]
    IntervalError(#[from] IntervalError),
    #[error("Scale error: {0}")]
    ScaleError(#[from] ScaleError),
}

/// A macro to create a `ResonataError` from a `NoteError`, `IntervalError` or `ScaleError`
#[macro_export]
macro_rules! err {
    ($e:expr) => {
        Err(ResonataError::from($e))
    };
}

/// A macro to return a `ResonataError` from a `NoteError`, `IntervalError` or `ScaleError`
#[macro_export]
macro_rules! nope {
    ($e:expr) => {
        return Err(ResonataError::from($e))
    };
}

#[macro_export]
macro_rules! yep {
    ($e:expr) => {
        return Ok($e)
    };
}