laminar 0.2.3

A simple semi-reliable UDP protocol for multiplayer games
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use crate::packet::EnumConverter;

/// Enum to specify how a packet should be delivered.
#[derive(Copy, Clone, Debug, PartialOrd, PartialEq, Eq)]
pub enum DeliveryGuarantee {
    /// Packet may or may not be delivered
    Unreliable,
    /// Packet will be delivered
    Reliable,
}

impl EnumConverter for DeliveryGuarantee {
    type Enum = DeliveryGuarantee;

    /// Get integer value from `DeliveryGuarantee` enum.
    fn to_u8(&self) -> u8 {
        *self as u8
    }

    /// Get `DeliveryGuarantee` enum instance from integer value.
    fn from_u8(input: u8) -> Self::Enum {
        match input {
            0 => DeliveryGuarantee::Unreliable,
            1 => DeliveryGuarantee::Reliable,
            _ => unimplemented!("Delivery Guarantee {} does not exist yet.", input),
        }
    }
}

/// Enum to specify how a packet should be arranged.
#[derive(Copy, Clone, Debug, PartialOrd, PartialEq, Eq)]
pub enum OrderingGuarantee {
    /// No arranging will be done.
    None,
    /// Packets will be arranged in sequence.
    Sequenced(Option<u8>),
    /// Packets will be arranged in order.
    Ordered(Option<u8>),
}

impl Default for OrderingGuarantee {
    fn default() -> Self {
        OrderingGuarantee::None
    }
}

impl EnumConverter for OrderingGuarantee {
    type Enum = OrderingGuarantee;

    /// Get integer value from `OrderingGuarantee` enum.
    fn to_u8(&self) -> u8 {
        match self {
            OrderingGuarantee::None => 0,
            OrderingGuarantee::Sequenced(_) => 1,
            OrderingGuarantee::Ordered(_) => 2,
        }
    }

    /// Get `OrderingGuarantee` enum instance from integer value.
    fn from_u8(input: u8) -> Self::Enum {
        match input {
            0 => OrderingGuarantee::None,
            1 => OrderingGuarantee::Sequenced(None),
            2 => OrderingGuarantee::Ordered(None),
            _ => unimplemented!("Ordering Guarantee {} does not exist yet.", input),
        }
    }
}

#[derive(Copy, Clone, Debug, PartialOrd, PartialEq)]
/// Id to identify a certain packet type.
pub enum PacketType {
    /// Full packet that is not fragmented
    Packet = 0,
    /// Fragment of a full packet
    Fragment = 1,
}

impl EnumConverter for PacketType {
    type Enum = PacketType;

    fn to_u8(&self) -> u8 {
        *self as u8
    }

    fn from_u8(input: u8) -> Self::Enum {
        match input {
            0 => PacketType::Packet,
            1 => PacketType::Fragment,
            _ => unimplemented!("Packet ID {} does not exist yet.", input),
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::packet::{
        enums::{DeliveryGuarantee, OrderingGuarantee, PacketType},
        EnumConverter,
    };

    #[test]
    fn assure_parsing_ordering_guarantee() {
        let none = OrderingGuarantee::None;
        let ordered = OrderingGuarantee::Ordered(None);
        let sequenced = OrderingGuarantee::Sequenced(None);

        assert_eq!(
            OrderingGuarantee::None,
            OrderingGuarantee::from_u8(none.to_u8())
        );
        assert_eq!(
            OrderingGuarantee::Ordered(None),
            OrderingGuarantee::from_u8(ordered.to_u8())
        );
        assert_eq!(
            OrderingGuarantee::Sequenced(None),
            OrderingGuarantee::from_u8(sequenced.to_u8())
        )
    }

    #[test]
    fn assure_parsing_delivery_guarantee() {
        let unreliable = DeliveryGuarantee::Unreliable;
        let reliable = DeliveryGuarantee::Reliable;
        assert_eq!(
            DeliveryGuarantee::Unreliable,
            DeliveryGuarantee::from_u8(unreliable.to_u8())
        );
        assert_eq!(
            DeliveryGuarantee::Reliable,
            DeliveryGuarantee::from_u8(reliable.to_u8())
        )
    }

    #[test]
    fn assure_parsing_packet_id() {
        let packet = PacketType::Packet;
        let fragment = PacketType::Fragment;
        assert_eq!(PacketType::Packet, PacketType::from_u8(packet.to_u8()));
        assert_eq!(PacketType::Fragment, PacketType::from_u8(fragment.to_u8()))
    }
}