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 change-shared-party-experience packet.

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

use super::prelude::*;

/// Packet sent by the client to enable or disable shared party experience.
///
/// # Examples
/// ```
/// use suon_protocol::packets::client::{Decodable, prelude::ChangeSharedPartyExperiencePacket};
///
/// let mut payload: &[u8] = &[1];
/// let packet = ChangeSharedPartyExperiencePacket::decode(&mut payload).unwrap();
///
/// assert!(packet.is_enabled);
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ChangeSharedPartyExperiencePacket {
    /// Whether shared party experience should be active.
    pub is_enabled: bool,
}

impl Decodable for ChangeSharedPartyExperiencePacket {
    const KIND: PacketKind = PacketKind::ChangeSharedPartyExperience;

    fn decode(mut bytes: &mut &[u8]) -> Result<Self, DecodableError> {
        Ok(Self {
            is_enabled: bytes.get_u8()? == 1,
        })
    }
}

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

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

        let packet = ChangeSharedPartyExperiencePacket::decode(&mut payload)
            .expect("ChangeSharedPartyExperience packets should decode the shared experience flag");

        assert!(packet.is_enabled);
        assert!(
            payload.is_empty(),
            "ChangeSharedPartyExperience decoding should consume the whole payload"
        );
    }

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