open_dmx 1.1.1

A wrapper around the serialport library to send DMX data over a serial port
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

//! Error types for the library


/// Error for when the [DMXSerial] port is disconnected.
/// 
/// [DMXSerial]: crate::DMXSerial
/// [methods]: crate::DMXSerial#implementations
///
#[derive(Debug)]
pub struct DMXDisconnectionError;

impl std::fmt::Display for DMXDisconnectionError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "DMX Port disconnected")
    }
} 

impl std::error::Error for DMXDisconnectionError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        None
    }
}

    /// Error for when the channel is not inside the valid channel range of [`DMX_CHANNELS`].
    /// 
    /// - [`DMXChannelValidityError::TooLow`] if the channel is lower than `1`.
    /// 
    /// - [`DMXChannelValidityError::TooHigh`] if the channel is higher than [`DMX_CHANNELS`].
    /// 
    /// [`DMX_CHANNELS`]: crate::DMX_CHANNELS
#[derive(Debug)]
pub enum DMXChannelValidityError {
    TooHigh,
    TooLow,
}

impl std::fmt::Display for DMXChannelValidityError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            DMXChannelValidityError::TooHigh => write!(f, "DMX channel too high"),
            DMXChannelValidityError::TooLow => write!(f, "DMX channel too low"),
        }
    }
}

impl std::error::Error for DMXChannelValidityError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        None
    }
}