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

//! Read and write 0-terminated byte strings.
//!
//! Example:
//!
//! ```
//! use rwutil::bytes0::ReadBytes0Ext;
//!
//! // a &[u8] implements the io::Read interface
//! let src: Vec<u8> = vec![0x61, 0x62, 0x63, 0];
//!
//! // reading data into a new vector
//! let buf: Vec<u8> = src.as_slice().read_bytes0().unwrap();
//!
//! assert_eq!(buf, b"abc")
//! ```
//!
//! # Security
//! The current implementation is similar to the trouble `gets` from C in that
//! it does not have a maximum size for reading. While you will not encounter
//! a buffer overflow, the vector the string is read into can grow arbitrarily
//! large, allow a supplier of untrusted data to cause an OOM panic if allowed
//! to send an infinite amount of data.

use std::io;
use std::io::{Read, Write};

pub trait ReadBytes0Ext : Read {
    fn read_bytes0(&mut self) -> io::Result<Vec<u8>> {
        let it = self.bytes();

        let result: Result<Vec<u8>,_> =
            it.take_while(|b| match *b {
                Ok(b) => b != 0,
                _ => true
            }).collect();

        Ok(try!(result))
    }
}

pub trait WriteBytes0Ext : Write {
    fn write_bytes0(&mut self, data: &[u8]) -> io::Result<()> {
        try!(self.write_all(data));
        try!(self.write_all(&[0; 1]));
        Ok(())
    }
}

impl<R: Read> ReadBytes0Ext for R {
}

impl<W: Write> WriteBytes0Ext for W {
}

#[cfg(test)]
mod test {
    use bytes0::{ReadBytes0Ext, WriteBytes0Ext};

    #[test]
    fn test_bytes0() {
        let buf = vec![0x61, 0x62, 0x63, 0];
        assert_eq!(buf.as_slice().read_bytes0().unwrap(), b"abc");

        let mut out = Vec::new();
        out.write_bytes0(b"abc").unwrap();
        assert_eq!(buf, out);
    }
}