suon_protocol 0.1.0

Binary protocol encoding and decoding for the Suon MMORPG framework
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

//! Client keep-alive packet.

use super::prelude::*;

/// Packet sent by the client to keep the session active without payload data.
///
/// # Examples
/// ```
/// use suon_protocol::packets::client::{Decodable, prelude::KeepAlivePacket};
///
/// let mut payload: &[u8] = &[];
/// let packet = KeepAlivePacket::decode(&mut payload).unwrap();
///
/// assert!(matches!(packet, KeepAlivePacket));
/// ```
pub struct KeepAlivePacket;

impl Decodable for KeepAlivePacket {
    const KIND: PacketKind = PacketKind::KeepAlive;

    fn decode(_: &mut &[u8]) -> Result<Self, DecodableError> {
        Ok(KeepAlivePacket)
    }
}

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

    #[test]
    fn should_decode_keep_alive_from_empty_payload() {
        let mut payload: &[u8] = &[];

        let packet = KeepAlivePacket::decode(&mut payload)
            .expect("KeepAlive packets should decode without payload bytes");

        assert!(matches!(packet, KeepAlivePacket));

        assert!(
            payload.is_empty(),
            "KeepAlive decoding should not consume any payload bytes"
        );
    }

    #[test]
    fn should_expose_keep_alive_kind_constant() {
        assert_eq!(
            KeepAlivePacket::KIND,
            PacketKind::KeepAlive,
            "KeepAlive packets should advertise the correct packet kind"
        );
    }
}