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

//! Client cancel-steps packet.

use super::prelude::*;

/// Packet sent by the client to cancel an active step sequence without payload data.
///
/// # Examples
/// ```
/// use suon_protocol::packets::client::{Decodable, prelude::CancelStepsPacket};
///
/// let mut payload: &[u8] = &[];
/// let packet = CancelStepsPacket::decode(&mut payload).unwrap();
///
/// assert!(matches!(packet, CancelStepsPacket));
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CancelStepsPacket;

impl Decodable for CancelStepsPacket {
    const KIND: PacketKind = PacketKind::CancelSteps;

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

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

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

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

        assert!(matches!(packet, CancelStepsPacket));
        assert!(
            payload.is_empty(),
            "CancelSteps decoding should not consume any payload bytes"
        );
    }
}