rwutil 2.0.0

Extends io::{Read,Write} with methods for reading length-prefixed strings
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210

//! Length-prefixed reading and writing
//!
//! Implements a popular format for sending data packets: First, a fixed width
//! integer in a fixed byte order is sent with the length of the data,
//! followed by the actual data.
use byteorder::{ReadBytesExt, WriteBytesExt, ByteOrder};
use std::io;

/// Implements sending of byte-slices with a length prefix.
pub trait WritePrefixedExt : io::Write {
    fn write_u8_prefixed(&mut self, data: &[u8]) ->
        io::Result<()>;
    fn write_u16_prefixed<T: ByteOrder>(&mut self, data: &[u8]) ->
        io::Result<()>;
    fn write_u32_prefixed<T: ByteOrder>(&mut self, data: &[u8]) ->
        io::Result<()>;
    fn write_u64_prefixed<T: ByteOrder>(&mut self, data: &[u8]) ->
        io::Result<()>;
}

/// Implements reading length-prefixed data.
pub trait ReadPrefixedExt : io::Read {
    fn read_u8_prefixed(&mut self, buf: &mut Vec<u8>) ->
        io::Result<u8>;
    fn read_u16_prefixed<T: ByteOrder>(&mut self, buf: &mut Vec<u8>) ->
        io::Result<u16>;
    fn read_u32_prefixed<T: ByteOrder>(&mut self, buf: &mut Vec<u8>) ->
        io::Result<u32>;
    fn read_u64_prefixed<T: ByteOrder>(&mut self, buf: &mut Vec<u8>) ->
        io::Result<u64>;
}

impl<W: io::Write> WritePrefixedExt for W {
    fn write_u8_prefixed(&mut self, data: &[u8]) ->
    io::Result<()> {
        try!(self.write_u8(data.len() as u8));
        try!(self.write_all(&data));

        Ok(())
    }

    fn write_u16_prefixed<T: ByteOrder>(&mut self, data: &[u8]) ->
    io::Result<()> {
        try!(self.write_u16::<T>(data.len() as u16));
        try!(self.write_all(&data));

        Ok(())
    }

    fn write_u32_prefixed<T: ByteOrder>(&mut self, data: &[u8]) ->
    io::Result<()> {
        try!(self.write_u32::<T>(data.len() as u32));
        try!(self.write_all(&data));
        Ok(())
    }

    fn write_u64_prefixed<T: ByteOrder>(&mut self, data: &[u8]) ->
    io::Result<()> {
        try!(self.write_u64::<T>(data.len() as u64));
        try!(self.write_all(&data));

        Ok(())
    }
}

impl<R: io::Read> ReadPrefixedExt for R {
    fn read_u8_prefixed(&mut self, mut buf: &mut Vec<u8>) -> io::Result<u8> {
        let len = try!(self.read_u8());

        // expand size of buffer to fit new data. this will hopefully not
        // shrink the vector
        buf.resize(len as usize, 0);

        try!(self.read_exact(&mut buf));
        Ok(len)
    }

    fn read_u16_prefixed<T: ByteOrder>(&mut self, mut buf: &mut Vec<u8>) ->
    io::Result<u16> {
        let len = try!(self.read_u16::<T>());

        // FIXME: probably better to grow vector dynamically here; as
        // preallocating this much memory could be an invitation for DOS
        // attacks. same goes for u32 and u64 below

        buf.resize(len as usize, 0);

        try!(self.read_exact(&mut buf));
        Ok(len)
    }

    fn read_u32_prefixed<T: ByteOrder>(&mut self, mut buf: &mut Vec<u8>) ->
    io::Result<u32> {
        let len = try!(self.read_u32::<T>());

        buf.resize(len as usize, 0);

        try!(self.read_exact(&mut buf));
        Ok(len)
    }

    fn read_u64_prefixed<T: ByteOrder>(&mut self, mut buf: &mut Vec<u8>) ->
    io::Result<u64> {
        let len = try!(self.read_u64::<T>());

        buf.resize(len as usize, 0);

        try!(self.read_exact(&mut buf));
        Ok(len)
    }
}

#[cfg(test)]
mod test {
    use length_prefixed::{WritePrefixedExt, ReadPrefixedExt};
    use byteorder::{BigEndian, LittleEndian};

    #[test]
    fn test_u8_prefixed_write() {
        let mut buf = Vec::new();
        let expected = vec![5, 0x61, 0x62, 0x63, 0x64, 0x65];
        buf.write_u8_prefixed(b"abcde").unwrap();

        assert_eq!(expected, buf);

        let mut out = Vec::new();
        buf.as_slice().read_u8_prefixed(&mut out).unwrap();
        assert_eq!(out, b"abcde");
    }

    #[test]
    fn test_u16_prefixed_write_be() {
        let mut buf = Vec::new();
        let expected = vec![0, 5, 0x61, 0x62, 0x63, 0x64, 0x65];
        buf.write_u16_prefixed::<BigEndian>(b"abcde").unwrap();

        assert_eq!(expected, buf);

        let mut out = Vec::new();
        buf.as_slice().read_u16_prefixed::<BigEndian>(&mut out).unwrap();
        assert_eq!(out, b"abcde");
    }

    #[test]
    fn test_u32_prefixed_write_be() {
        let mut buf = Vec::new();
        let expected = vec![0, 0, 0, 5, 0x61, 0x62, 0x63, 0x64, 0x65];
        buf.write_u32_prefixed::<BigEndian>(b"abcde").unwrap();

        assert_eq!(expected, buf);

        let mut out = Vec::new();
        buf.as_slice().read_u32_prefixed::<BigEndian>(&mut out).unwrap();
        assert_eq!(out, b"abcde");
    }

    #[test]
    fn test_u64_prefixed_write_be() {
        let mut buf = Vec::new();
        let expected = vec![0, 0, 0, 0, 0, 0, 0, 5,
                            0x61, 0x62, 0x63, 0x64, 0x65];
        buf.write_u64_prefixed::<BigEndian>(b"abcde").unwrap();

        assert_eq!(expected, buf);

        let mut out = Vec::new();
        buf.as_slice().read_u64_prefixed::<BigEndian>(&mut out).unwrap();
        assert_eq!(out, b"abcde");
    }

    #[test]
    fn test_u16_prefixed_write_le() {
        let mut buf = Vec::new();
        let expected = vec![5, 0, 0x61, 0x62, 0x63, 0x64, 0x65];
        buf.write_u16_prefixed::<LittleEndian>(b"abcde").unwrap();

        assert_eq!(expected, buf);

        let mut out = Vec::new();
        buf.as_slice().read_u16_prefixed::<LittleEndian>(&mut out).unwrap();
        assert_eq!(out, b"abcde");
    }

    #[test]
    fn test_u32_prefixed_write_le() {
        let mut buf = Vec::new();
        let expected = vec![5, 0, 0, 0, 0x61, 0x62, 0x63, 0x64, 0x65];
        buf.write_u32_prefixed::<LittleEndian>(b"abcde").unwrap();

        assert_eq!(expected, buf);

        let mut out = Vec::new();
        buf.as_slice().read_u32_prefixed::<LittleEndian>(&mut out).unwrap();
        assert_eq!(out, b"abcde");
    }

    #[test]
    fn test_u64_prefixed_write_le() {
        let mut buf = Vec::new();
        let expected = vec![5, 0, 0, 0, 0, 0, 0, 0,
                            0x61, 0x62, 0x63, 0x64, 0x65];
        buf.write_u64_prefixed::<LittleEndian>(b"abcde").unwrap();

        assert_eq!(expected, buf);

        let mut out = Vec::new();
        buf.as_slice().read_u64_prefixed::<LittleEndian>(&mut out).unwrap();
        assert_eq!(out, b"abcde");
    }
}