ezsp 7.3.1

Ember ZNet Serial 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

use core::fmt::{self, Debug, Display};
use core::hash::Hash;

pub use self::extended::Extended;
pub use self::high_byte::{FormatVersion, HighByte};
pub use self::legacy::Legacy;
pub use self::low_byte::{CallbackType, Command, LowByte, SleepMode};

mod extended;
mod high_byte;
mod legacy;
mod low_byte;

/// EZSP header formats.
///
/// The `version` command can be sent using the legacy frame format so hosts and
/// NCPs with different protocol versions can negotiate. Once protocol version 8
/// or newer is active, regular frames use the extended header.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub enum Header {
    /// Legacy three-byte header.
    Legacy(Legacy),
    /// Extended five-byte header.
    Extended(Extended),
}

impl Header {
    /// Returns the header's sequence number.
    #[must_use]
    pub const fn sequence(self) -> u8 {
        match self {
            Self::Legacy(legacy) => legacy.sequence(),
            Self::Extended(extended) => extended.sequence(),
        }
    }

    /// Returns the low byte.
    #[must_use]
    pub const fn low_byte(self) -> LowByte {
        match self {
            Self::Legacy(legacy) => legacy.low_byte(),
            Self::Extended(extended) => extended.low_byte(),
        }
    }

    /// Returns the header's frame ID as a `u16`,
    #[must_use]
    pub fn id(self) -> u16 {
        match self {
            Self::Legacy(legacy) => u16::from(legacy.id()),
            Self::Extended(extended) => extended.id(),
        }
    }

    /// Returns `true` if the header indicates an asynchronous callback else `false`.
    #[must_use]
    pub fn is_async_callback(self) -> bool {
        if let LowByte::Response(response) = self.low_byte() {
            response.callback_type() == Some(CallbackType::Async)
        } else {
            false
        }
    }
}

impl Display for Header {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Legacy(legacy) => write!(f, "Legacy({legacy})"),
            Self::Extended(extended) => write!(f, "Extended({extended})"),
        }
    }
}