rstmt-nrt 0.1.0

this crate focuses on providing support for the neo-riemannian theory of music
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: error <module>
    Contrib: @FL03
*/
//! custom error types for the `nrt` crate

/// a type alias for a [`Result`](core::result::Result) with [`TriadError`] as its error type.
pub(crate) type Result<T = ()> = core::result::Result<T, TriadError>;

/// the [`TriadError`] type enumerates the various errors that one can expect to encounter
/// within the crate.
#[derive(Debug, thiserror::Error)]
pub enum TriadError {
    #[error("Incompatible triad classes")]
    IncompatibleTriadClasses,
    #[error(
        "Invalid transformation character ({0}); character must be 'L', 'P', or 'R' (case-insensitive)"
    )]
    TransformationParseCharError(char),
    #[error("Invalid triad")]
    InvalidTriad,
    #[error("Invalid Triad Class")]
    InvalidTriadClass,
    #[error(transparent)]
    CoreError(#[from] rstmt_core::Error),
    #[error(transparent)]
    GraphError(#[from] rshyper::Error),
}

impl From<TriadError> for rstmt::Error {
    fn from(err: TriadError) -> Self {
        match err {
            TriadError::CoreError(e) => e,
            #[cfg(feature = "alloc")]
            _ => rstmt_core::Error::boxed(err),
        }
    }
}

#[cfg(feature = "alloc")]
impl From<&str> for TriadError {
    fn from(err: &str) -> Self {
        rstmt::Error::from(err).into()
    }
}

#[cfg(feature = "alloc")]
impl From<alloc::string::String> for TriadError {
    fn from(err: alloc::string::String) -> Self {
        rstmt::Error::from(err).into()
    }
}