ssp 0.5.4

Messages and related types for implementing the SSP/eSSP serial communication protocol
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

use crate::{channel_value, std::fmt, ChannelValue, Error, ResponseStatus, Result};

use super::Method;

/// Represents a [Read](crate::ResponseStatus::Read) event.
#[derive(Clone, Copy, Debug, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct ReadEvent {
    value: ChannelValue,
}

impl ReadEvent {
    /// Creates a new [ReadEvent] from the [ChannelValue].
    pub const fn new(value: ChannelValue) -> Self {
        Self { value }
    }

    /// Gets the [Method] for the [ReadEvent].
    pub const fn method() -> Method {
        Method::Read
    }

    /// Converts the [ReadEvent] to a string.
    pub const fn to_str(&self) -> &'static str {
        Self::method().to_str()
    }

    /// Gets the [ChannelValue].
    pub const fn value(&self) -> ChannelValue {
        self.value
    }

    /// Sets the [ChannelValue].
    pub fn set_value(&mut self, value: ChannelValue) {
        self.value = value;
    }

    /// Gets the length of the event in a [PollResponse](crate::PollResponse).
    pub const fn len() -> usize {
        2
    }
}

impl TryFrom<&[u8]> for ReadEvent {
    type Error = Error;

    fn try_from(val: &[u8]) -> Result<Self> {
        match val.len() {
            0..=1 => Err(Error::InvalidLength((val.len(), 2))),
            _ => {
                let event = ResponseStatus::from(val[0]);
                if event == ResponseStatus::Read {
                    Ok(Self::new(channel_value(val[1] as usize)?))
                } else {
                    Err(Error::InvalidEvent((event, ResponseStatus::Read)))
                }
            }
        }
    }
}

impl<const N: usize> TryFrom<[u8; N]> for ReadEvent {
    type Error = Error;

    fn try_from(val: [u8; N]) -> Result<Self> {
        val.as_ref().try_into()
    }
}

impl<const N: usize> TryFrom<&[u8; N]> for ReadEvent {
    type Error = Error;

    fn try_from(val: &[u8; N]) -> Result<Self> {
        val.as_ref().try_into()
    }
}

impl From<ChannelValue> for ReadEvent {
    fn from(val: ChannelValue) -> Self {
        Self::new(val)
    }
}

impl From<&ChannelValue> for ReadEvent {
    fn from(val: &ChannelValue) -> Self {
        (*val).into()
    }
}

impl From<&ReadEvent> for &'static str {
    fn from(val: &ReadEvent) -> Self {
        val.to_str()
    }
}

impl From<ReadEvent> for &'static str {
    fn from(val: ReadEvent) -> Self {
        (&val).into()
    }
}

impl fmt::Display for ReadEvent {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let method = self.to_str();
        let value = self.value();

        write!(f, r#"{{"{method}": {{"value": {value}}}}}"#)
    }
}

impl Default for ReadEvent {
    fn default() -> Self {
        Self::new(ChannelValue::default())
    }
}