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

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

use super::Method;

/// Represents a [Enable](crate::ResponseEnable::Enable) event.
#[derive(Clone, Copy, Debug, Default, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct EnableEvent {
    protocol: ProtocolVersion,
}

impl EnableEvent {
    /// Creates a new [EnableEvent].
    pub const fn new(protocol: ProtocolVersion) -> Self {
        Self { protocol }
    }

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

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

    /// Gets the [ProtocolVersion].
    pub const fn protocol_version(&self) -> ProtocolVersion {
        self.protocol
    }

    /// Sets the [ProtocolVersion].
    pub fn set_protocol_version(&mut self, protocol: ProtocolVersion) {
        self.protocol = protocol;
    }

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

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

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

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

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

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

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