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
211
212
213
214
215
216
217
218
219
use std::cmp::min;
use std::io::{Read, Write};

/// A ring byte buffer used to operate byte streams
/// 
/// # Example
/// 
/// ```rust
/// # use std::io::Write;
/// let mut buffer = rpos_drv::RingByteBuffer::with_capacity(100);
/// buffer.write(&[0, 1, 2, 3]).unwrap();
/// assert_eq!(buffer.len(), 4 as usize);
/// ```
#[derive(Debug, Clone, PartialEq)]
pub struct RingByteBuffer {
    buf: Vec<u8>,
    head: usize,
    size: usize,
}

impl RingByteBuffer {
    /// create a ring buffer with capacity
    pub fn with_capacity(capacity: usize) -> RingByteBuffer {
        RingByteBuffer {
            buf: vec![0; capacity],
            head: 0,
            size: 0,
        }
    }

    /// the data in the ring buffer
    pub fn len(&self) -> usize {
        return self.size;
    }

    /// the capacity of the ring buffer
    pub fn capacity(&self) -> usize {
        return self.buf.len();
    }

    /// free space in bytes in the ring buffer
    pub fn free_space(&self) -> usize {
        return self.buf.len() - self.size;
    }

    /// current tail index of the ring buffer
    fn tail(&self) -> usize {
        return (self.head + self.size) % self.buf.len();
    }

    /// current read slice
    /// 
    /// # Example
    /// ```rust
    /// # use std::io::{ stdout, Write };
    /// # let mut buffer = rpos_drv::RingByteBuffer::with_capacity(100);
    /// # let mut some_stream = stdout();
    /// let read_slice = buffer.current_read_slice();
    /// let read = some_stream.write(read_slice).unwrap();
    /// buffer.skip_bytes(read);
    /// ```
    pub fn current_read_slice(&self) -> &[u8] {
        let end = min(self.head+self.size, self.buf.len());
        return &self.buf[self.head..end];
    }

    /// skip bytes
    pub fn skip_bytes(&mut self, bytes: usize) -> usize {
        let skipped = min(self.size, bytes);
        self.head = (self.head + skipped) % self.buf.len();
        self.size -= skipped;
        return skipped;
    }

    /// current write slice
    fn current_write_slice(&mut self) -> &mut[u8] {
        let current_end = self.tail();
        let write_buf_end = min(self.buf.len(), current_end + self.free_space());
        return &mut self.buf[current_end..write_buf_end];
    }

    /// mark bytes as written
    fn mark_bytes_as_written(&mut self, bytes: usize) {
        let written = min(self.free_space(), bytes);
        self.size += written;
    }

    fn partial_read_from(&mut self, upstream: &mut impl Read) -> std::io::Result<usize> {
        if self.current_write_slice().len() == 0 {
            return Ok(0);
        }

        match upstream.read(self.current_write_slice()) {
            Ok(read) => {
                self.mark_bytes_as_written(read);
                Ok(read)
            },
            Err(err) => {
                if err.kind() == std::io::ErrorKind::TimedOut {
                    Ok(0)
                } else {
                    Err(err)
                }
            }
        }
    }

    /// read data from upstream to fill the ring buffer
    /// 
    /// # Example
    /// ```rust
    /// # use std::io::{ stdin, Read };
    /// # let mut buffer = rpos_drv::RingByteBuffer::with_capacity(100);
    /// # let mut some_stream = stdin();
    /// let read = buffer.read_from(&mut some_stream).unwrap();
    /// println!("{} bytes read from stream to fill buffer, current length of buffer is: {}", read, buffer.len());
    /// ```
    pub fn read_from(&mut self, upstream: &mut impl Read) -> std::io::Result<usize> {
        let read = self.partial_read_from(upstream)?;

        match self.partial_read_from(upstream) {
            Ok(latter_read) => Ok(read + latter_read),
            Err(err) => Err(err)
        }
    }
}

impl Read for RingByteBuffer {
    fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
        let read = {
            let current_read_slice = self.current_read_slice();
            let read = min(current_read_slice.len(), buf.len());
            buf[0..read].clone_from_slice(&current_read_slice[0..read]);

            read
        };
        self.skip_bytes(read);

        let latter_read = {
            let current_read_slice = self.current_read_slice();
            let latter_read = min(current_read_slice.len(), buf.len() - read);
            buf[read..read + latter_read].clone_from_slice(&current_read_slice[0..latter_read]);

            latter_read
        };
        self.skip_bytes(latter_read);

        return Ok(read + latter_read);
    }
}

impl Write for RingByteBuffer {
    fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
        let written = {
            let current_write_slice = self.current_write_slice();
            let written = min(current_write_slice.len(), buf.len());
            current_write_slice[0..written].clone_from_slice(&buf[0..written]);
            written
        };
        self.mark_bytes_as_written(written);

        let latter_written = {
            let current_write_slice = self.current_write_slice();
            let latter_written = min(current_write_slice.len(), buf.len() - written);
            current_write_slice[0..latter_written].clone_from_slice(&buf[written..written + latter_written]);
            latter_written
        };
        self.mark_bytes_as_written(latter_written);

        return Ok(written + latter_written);
    }

    fn flush(&mut self) -> std::io::Result<()> {
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use std::io::{Read, Write};

    #[test]
    fn ctor() {
        let ringbuf = super::RingByteBuffer::with_capacity(100);

        assert_eq!(ringbuf.len(), 0);
        assert_eq!(ringbuf.capacity(), 100);
        assert_eq!(ringbuf.free_space(), 100);
        assert_eq!(ringbuf.current_read_slice().len(), 0);
    }

    #[test]
    fn read_and_write() {
        let mut ringbuf = super::RingByteBuffer::with_capacity(6);

        let test_data = vec![1,2,3,4];

        assert_eq!(ringbuf.write(&test_data[..]).unwrap(), 4);
        assert_eq!(ringbuf.len(), 4);
        assert_eq!(ringbuf.free_space(), 2);

        assert_eq!(ringbuf.write(&test_data[..]).unwrap(), 2);
        assert_eq!(ringbuf.len(), 6);
        assert_eq!(ringbuf.free_space(), 0);

        assert_eq!(ringbuf.current_read_slice(), [1, 2, 3, 4, 1, 2]);

        let mut read_buf = [0; 5];

        assert_eq!(ringbuf.read(&mut read_buf).unwrap(), 5);
        assert_eq!(read_buf, [1, 2, 3, 4, 1]);
        assert_eq!(ringbuf.len(), 1);
        assert_eq!(ringbuf.free_space(), 5);
        assert_eq!(ringbuf.read(&mut read_buf).unwrap(), 1);
        assert_eq!(read_buf, [2, 2, 3, 4, 1]);
        assert_eq!(ringbuf.len(), 0);
        assert_eq!(ringbuf.free_space(), 6);
    }
}