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
54
55
56
57
58
59
60

//! Client join-party packet.

use crate::packets::decoder::Decoder;

use super::prelude::*;

/// Packet sent by the client to join the party of a target player.
///
/// # Examples
/// ```
/// use suon_protocol::packets::client::{Decodable, prelude::JoinPartyPacket};
///
/// let mut payload: &[u8] = &[0x78, 0x56, 0x34, 0x12];
/// let packet = JoinPartyPacket::decode(&mut payload).unwrap();
///
/// assert_eq!(packet.target_id, 0x12345678);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct JoinPartyPacket {
    /// Creature id of the party member whose invite is being accepted.
    pub target_id: u32,
}

impl Decodable for JoinPartyPacket {
    const KIND: PacketKind = PacketKind::JoinParty;

    fn decode(mut bytes: &mut &[u8]) -> Result<Self, DecodableError> {
        Ok(Self {
            target_id: bytes.get_u32()?,
        })
    }
}

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

    #[test]
    fn should_decode_join_party() {
        let mut payload: &[u8] = &[0x78, 0x56, 0x34, 0x12];

        let packet = JoinPartyPacket::decode(&mut payload)
            .expect("JoinParty packets should decode the target player id");

        assert_eq!(packet.target_id, 0x12345678);
        assert!(
            payload.is_empty(),
            "JoinParty decoding should consume the whole payload"
        );
    }

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