msrt 0.1.8

Portable MSRT protocol implementation.
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

//! Packet type definitions.

/// Packet type carried by the v1 packet header.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum PacketType {
    /// Packet carrying message fragment bytes.
    Data,
    /// Packet carrying best-effort log fragment bytes.
    Log,
    /// Packet carrying an ACK payload.
    Ack,
    /// Packet asking the peer to prove liveness.
    Ping,
    /// Packet proving liveness in response to a PING.
    Pong,
}

impl PacketType {
    /// Encoded DATA packet type.
    pub const DATA_CODE: u8 = 0x00;
    /// Encoded ACK packet type.
    pub const ACK_CODE: u8 = 0x01;
    /// Encoded PING packet type.
    pub const PING_CODE: u8 = 0x02;
    /// Encoded PONG packet type.
    pub const PONG_CODE: u8 = 0x03;
    /// Encoded LOG packet type.
    pub const LOG_CODE: u8 = 0x04;

    /// Returns the encoded packet type.
    #[must_use]
    pub const fn code(self) -> u8 {
        match self {
            Self::Data => Self::DATA_CODE,
            Self::Log => Self::LOG_CODE,
            Self::Ack => Self::ACK_CODE,
            Self::Ping => Self::PING_CODE,
            Self::Pong => Self::PONG_CODE,
        }
    }

    /// Decodes a packet type from raw bits.
    #[must_use]
    pub const fn from_code(code: u8) -> Option<Self> {
        match code {
            Self::DATA_CODE => Some(Self::Data),
            Self::LOG_CODE => Some(Self::Log),
            Self::ACK_CODE => Some(Self::Ack),
            Self::PING_CODE => Some(Self::Ping),
            Self::PONG_CODE => Some(Self::Pong),
            _ => None,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::PacketType;

    #[test]
    fn packet_type_codes_roundtrip() {
        assert_eq!(
            PacketType::from_code(PacketType::DATA_CODE),
            Some(PacketType::Data)
        );
        assert_eq!(
            PacketType::from_code(PacketType::LOG_CODE),
            Some(PacketType::Log)
        );
        assert_eq!(
            PacketType::from_code(PacketType::ACK_CODE),
            Some(PacketType::Ack)
        );
        assert_eq!(
            PacketType::from_code(PacketType::PING_CODE),
            Some(PacketType::Ping)
        );
        assert_eq!(
            PacketType::from_code(PacketType::PONG_CODE),
            Some(PacketType::Pong)
        );
        assert_eq!(PacketType::from_code(0xff), None);
    }
}