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

use crate::{std::fmt, ChannelValue};

use super::Method;

/// Represents a [Stack](crate::Method::Stack) event.
#[derive(Clone, Copy, Debug, Default, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct StackEvent {
    value: ChannelValue,
}

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

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

    /// Converts the [StackEvent] 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
    }

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

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

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

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

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

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

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