iowrap 0.2.1

Small helpers for using io::Read/io::Write
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

use std::io;
use std::io::Read;

/// Intentionally return short reads, to test `Read` code.
///
/// The `decider` iterator gets to decide how short a read should be.
/// A read length of 0 generates an `ErrorKind::Interrupted` error.
/// When the iterator runs out before the reader, `read` will always
/// return zero-length reads (EOF).
///
/// Currently, no effort is made to make reads longer, if the underlying
/// reader naturally returns short reads.
///
/// # Examples
///
/// Short read:
///
/// ```rust
/// # use std::io;
/// # use std::io::Read;
/// let mut naughty = iowrap::ShortRead::new(
///         io::Cursor::new(b"1234567890"),
///         vec![2, 3, 4, 5, 6].into_iter()
/// );
/// let mut buf = [0u8; 10];
/// // A `Cursor` would normally return the whole ten bytes here,
/// // but we've limited it to two bytes.
/// assert_eq!(2, naughty.read(&mut buf).unwrap());
/// ```
///
/// Interrupted read:
///
/// ```rust
/// # use std::io;
/// # use std::io::Read;
/// let mut interrupting = iowrap::ShortRead::new(
///         io::Cursor::new(b"123"),
///         vec![0, 1, 0].into_iter()
/// );
/// let mut buf = [0u8; 10];
/// assert_eq!(io::ErrorKind::Interrupted,
///         interrupting.read(&mut buf).unwrap_err().kind());
/// ```
pub struct ShortRead<R: Read, I: Iterator<Item = usize>> {
    inner: R,
    decider: I,
}

impl<R: Read, I: Iterator<Item = usize>> Read for ShortRead<R, I> {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        let wanted = match self.decider.next() {
            Some(0) => return Err(io::Error::from(io::ErrorKind::Interrupted)),
            Some(wanted) => wanted,
            None => return Ok(0),
        };
        let wanted = wanted.min(buf.len());

        let buf = &mut buf[..wanted];
        self.inner.read(buf)
    }
}

impl<R: Read, I: Iterator<Item = usize>> ShortRead<R, I> {
    pub fn new(inner: R, decider: I) -> Self {
        ShortRead { inner, decider }
    }

    pub fn into_inner(self) -> R {
        self.inner
    }
}

#[cfg(test)]
mod tests {
    use crate::short::ShortRead;
    use std::io;
    use std::io::Read;

    #[test]
    fn shorten() {
        let mut naughty = ShortRead::new(
            io::Cursor::new(b"1234567890"),
            vec![2, 3, 4, 5, 6].into_iter(),
        );
        let mut buf = [0u8; 10];
        assert_eq!(2, naughty.read(&mut buf).unwrap());
        assert_eq!(b"12", &buf[..2]);
        assert_eq!(3, naughty.read(&mut buf).unwrap());
        assert_eq!(b"345", &buf[..3]);
        assert_eq!(4, naughty.read(&mut buf).unwrap());
        assert_eq!(b"6789", &buf[..4]);
        assert_eq!(1, naughty.read(&mut buf).unwrap());
        assert_eq!(b"0", &buf[..1]);

        assert_eq!(0, naughty.read(&mut buf).unwrap());
        assert_eq!(0, naughty.read(&mut buf).unwrap());
    }

    #[test]
    fn interrupt() {
        let mut interrupting = ShortRead::new(io::Cursor::new(b"12"), vec![0, 1, 0, 1].into_iter());
        let mut buf = [0; 1];

        assert_eq!(
            io::ErrorKind::Interrupted,
            interrupting.read(&mut buf).unwrap_err().kind()
        );
        assert_eq!(1, interrupting.read(&mut buf).unwrap());
        assert_eq!(
            io::ErrorKind::Interrupted,
            interrupting.read(&mut buf).unwrap_err().kind()
        );
        assert_eq!(1, interrupting.read(&mut buf).unwrap());
    }

    #[test]
    fn std_bufreader_leaves_us_alone() {
        use std::io::BufRead;

        let mut naughty = io::BufReader::new(ShortRead::new(
            io::Cursor::new(b"1234567890"),
            vec![2, 3, 4, 5, 6].into_iter(),
        ));

        assert_eq!(b"12", naughty.fill_buf().unwrap());
        naughty.consume(1);
        assert_eq!(b"2", naughty.fill_buf().unwrap());
        naughty.consume(1);
        assert_eq!(b"345", naughty.fill_buf().unwrap());
        naughty.consume(1);
        assert_eq!(b"45", naughty.fill_buf().unwrap());
        naughty.consume(1);
        assert_eq!(b"5", naughty.fill_buf().unwrap());
        naughty.consume(1);
        assert_eq!(b"6789", naughty.fill_buf().unwrap());
        naughty.consume(1);
        assert_eq!(b"789", naughty.fill_buf().unwrap());
        naughty.consume(1);
        assert_eq!(b"89", naughty.fill_buf().unwrap());
        naughty.consume(1);
        assert_eq!(b"9", naughty.fill_buf().unwrap());
        naughty.consume(1);
        assert_eq!(b"0", naughty.fill_buf().unwrap());
        naughty.consume(1);
        assert_eq!(b"", naughty.fill_buf().unwrap());
    }
}