eznet 0.2.0

a simple net lib
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

use bytes::Bytes;
use serde::{Deserialize, Serialize};

//

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[repr(C)]
pub enum PacketHeader {
    /// no packets are dropped
    ///
    /// ordered
    Ordered { stream_id: Option<u8> },

    /// old packets are dropped
    ///
    /// ordered
    ReliableSequenced { stream_id: Option<u8>, seq_id: u16 },

    /// no packets are dropped
    ///
    /// not ordered
    ReliableUnordered,

    /// 'random' and old packets are dropped
    ///
    /// ordered
    UnreliableSequenced { stream_id: Option<u8>, seq_id: u16 },

    /// 'random' packets are dropped
    ///
    /// not ordered
    Unreliable,
}

//

impl Default for PacketHeader {
    fn default() -> Self {
        Self::Ordered { stream_id: None }
    }
}

//

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Packet {
    pub header: PacketHeader,
    pub bytes: Bytes,
}

//

impl Packet {
    /// no packets are dropped
    ///
    /// ordered
    pub fn ordered(bytes: Bytes, stream: Option<u8>) -> Self {
        Self {
            bytes,
            header: PacketHeader::Ordered { stream_id: stream },
        }
    }

    /// no packets are dropped
    ///
    /// ordered
    pub fn ordered_from(bytes: &[u8], stream: Option<u8>) -> Self {
        Self {
            bytes: Bytes::copy_from_slice(bytes),
            header: PacketHeader::Ordered { stream_id: stream },
        }
    }

    /// old packets are dropped
    ///
    /// ordered
    pub fn reliable_sequenced(bytes: Bytes, stream: Option<u8>) -> Self {
        Self {
            bytes,
            header: PacketHeader::ReliableSequenced {
                stream_id: stream,
                seq_id: 0,
            },
        }
    }

    /// old packets are dropped
    ///
    /// ordered
    pub fn reliable_sequenced_from(bytes: &[u8], stream: Option<u8>) -> Self {
        Self {
            bytes: Bytes::copy_from_slice(bytes),
            header: PacketHeader::ReliableSequenced {
                stream_id: stream,
                seq_id: 0,
            },
        }
    }

    /// no packets are dropped
    ///
    /// not ordered
    pub fn reliable_unordered(bytes: Bytes) -> Self {
        Self {
            bytes,
            header: PacketHeader::ReliableUnordered,
        }
    }

    /// no packets are dropped
    ///
    /// not ordered
    pub fn reliable_unordered_from(bytes: &[u8]) -> Self {
        Self {
            bytes: Bytes::copy_from_slice(bytes),
            header: PacketHeader::ReliableUnordered,
        }
    }

    /// 'random' and old packets are dropped
    ///
    /// ordered
    pub fn unreliable_sequenced(bytes: Bytes, stream: Option<u8>) -> Self {
        Self {
            bytes,
            header: PacketHeader::UnreliableSequenced {
                stream_id: stream,
                seq_id: 0,
            },
        }
    }

    /// 'random' and old packets are dropped
    ///
    /// ordered
    pub fn unreliable_sequenced_from(bytes: &[u8], stream: Option<u8>) -> Self {
        Self {
            bytes: Bytes::copy_from_slice(bytes),
            header: PacketHeader::UnreliableSequenced {
                stream_id: stream,
                seq_id: 0,
            },
        }
    }

    /// 'random' packets are dropped
    ///
    /// not ordered
    pub fn unreliable(bytes: Bytes) -> Self {
        Self {
            bytes,
            header: PacketHeader::Unreliable,
        }
    }

    /// 'random' packets are dropped
    ///
    /// not ordered
    pub fn unreliable_from(bytes: &[u8]) -> Self {
        Self {
            bytes: Bytes::copy_from_slice(bytes),
            header: PacketHeader::Unreliable,
        }
    }
}