rytm-rs 0.1.3

More than safe rust abstractions over rytm-sys, an unofficial SDK for Analog Rytm MKII running firmware 1.70
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

//! Error types for the rytm crate.
//!
//! [`SysexConversionError`] is mostly used to bubble up errors from `rytm-sys`.

/// Error type for conversion errors.
///
/// This is mostly used for enum types when converting from u8.
#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum ConversionError {
    #[error("Conversion error: {value} is out of range for {type_name}")]
    Range { value: String, type_name: String },
    #[error("Conversion error: The object name you have provided \"{0}\" is {1} characters and too long. The maximum length is 15 characters.")]
    ObjectNameTooLong(String, usize),
    #[error("Conversion error: The object name you have provided \"{0}\" contains non-ascii characters.")]
    ObjectNameNotAscii(String),
    #[error("Conversion error: The input value in the string needs to represent an integer.")]
    ParseIntError(#[from] std::num::ParseIntError),
}

/// Error type for parameter errors.
///
/// This is mostly used for parameter validation.
#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum ParameterError {
    #[error("Parameter error: {value} is out of range for {parameter_name}")]
    Range {
        value: String,
        parameter_name: String,
    },

    #[error("Parameter error: {value} is not compatible with {parameter_name}. {reason:?}")]
    Compatibility {
        value: String,
        parameter_name: String,
        reason: Option<String>,
    },
}

/// Error type for sysex conversion errors.
///
/// It is mostly used to bubble up errors from `rytm-sys`.
#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum SysexConversionError {
    #[error("Not a sysex message")]
    NotASysexMsg,
    #[error("Short read on sysex message")]
    ShortRead,
    #[error("End of message too soon")]
    EndOfMessage,
    #[error("Abort")]
    Abort,
    #[error("Invalid manufacturer ID")]
    InvalidManufacturerId,
    #[error("Invalid product ID")]
    InvalidProductId,
    #[error("Invalid dump message ID")]
    InvalidDumpMsgId,
    #[error("Invalid object type")]
    InvalidObjType,
    #[error("Checksum error")]
    Chksum,
    #[error("Null pointer")]
    Nullptr,
    #[error("Invalid object number")]
    InvalidObjNr,
    #[error("Not a pattern")]
    NotAPattern,
    #[error("Not a kit")]
    NotAKit,
    #[error("Not a sound")]
    NotASound,
    #[error("The type of the sysex message does not match the size of the message. Expected {0} got {1}")]
    InvalidSize(usize, usize),
    #[error("Unknown error code: {0}")]
    Unknown(u8),
    #[error("Sysex type of {0} is encountered but not implemented yet.")]
    Unimplemented(String),
}

impl From<u8> for SysexConversionError {
    fn from(code: u8) -> Self {
        match code {
            1 => Self::NotASysexMsg,
            2 => Self::ShortRead,
            3 => Self::EndOfMessage,
            4 => Self::Abort,
            5 => Self::InvalidManufacturerId,
            6 => Self::InvalidProductId,
            7 => Self::InvalidDumpMsgId,
            8 => Self::InvalidObjType,
            9 => Self::Chksum,
            10 => Self::Nullptr,
            11 => Self::InvalidObjNr,
            12 => Self::NotAPattern,
            13 => Self::NotAKit,
            14 => Self::NotASound,
            _ => Self::Unknown(code),
        }
    }
}

/// Wrapper error type for all rytm errors.
#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum RytmError {
    #[error("{0}")]
    Custom(String),
    #[error(transparent)]
    Conversion(#[from] ConversionError),
    #[error(transparent)]
    Parameter(#[from] ParameterError),
    #[error(transparent)]
    SysexConversion(#[from] SysexConversionError),

    #[error(transparent)]
    Serde(#[from] serde_json::Error),

    #[error("Parameter lock memory full.")]
    ParameterLockMemoryFull,
    #[error("Parameter lock pool is not set for this trig thus it is not connected to a pattern and orphan. This function can not be called on an orphan trig.")]
    OrphanTrig,
}