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
use std::io::{self, Read, Write};
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::{Arc};

pub mod conv;

/// read_full reads from r until buffer is full, EOF is met, or an io:Error occured.
///
/// On ok return:
/// If return size == buffer.len() the read is successful and there may be more data available from r.
/// If return size < buffer.len(), EOF is met before buffer is filled.
pub fn read_full(buffer: &mut [u8], r: &mut dyn Read) -> Result<usize, io::Error> {
    let mut len_read: usize = 0;
    loop {
        match r.read(&mut buffer[len_read..]) {
            Ok(size) => {
                len_read += size;
                if size == 0 || buffer.len() == len_read {
                    return Ok(len_read);
                }
            }
            Err(e) => return Err(e),
        }
    }
}

/// BlackHole implements io::Write trait.
///
/// Writes to BlackHole always succeeds.
pub struct BlackHole {}
impl Write for BlackHole {
    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
        Ok(buf.len())
    }
    fn flush(&mut self) -> io::Result<()> {
        Ok(())
    }
}

struct MeteringReaderHandle<'a> {
    underlying_reader: &'a mut dyn Read,
    counter: Arc<AtomicUsize>,
}

/// MeteringReader wraps around a reader and atomically accumulates the total count of bytes written to it.
///
/// Use as_reader() to obtain a io::Reader handle to it.
pub struct MeteringReader<'a> {
    inner: MeteringReaderHandle<'a>,
    counter: Arc<AtomicUsize>,
}

impl MeteringReader<'_> {
    pub fn new(r: &mut dyn Read) -> MeteringReader {
        let counter = Arc::new(AtomicUsize::new(0));
        MeteringReader{
            inner : MeteringReaderHandle{
                underlying_reader: r,
                counter: Arc::clone(&counter),
            },
            counter: Arc::clone(&counter),
        }
    }

    pub fn as_reader(&mut self) -> &mut dyn Read {
        &mut self.inner
    }

    pub fn get_counter(&self) -> usize {
        self.counter.load(Ordering::Relaxed)
    }
}

impl Read for MeteringReaderHandle<'_> {
    fn read(&mut self, buf: &mut [u8]) -> Result<usize, io::Error> {
        match self.underlying_reader.read(buf) {
            Ok(size) => {
                self.counter.fetch_add(size, Ordering::Relaxed);
                Ok(size)
            },
            Err(e) => {
                Err(e)
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use crate as lib;
    use std::io::{self, Read};

    pub struct SlowReader<'a> {
        underlying_reader: &'a mut dyn (Read),
    }

    impl Read for SlowReader<'_> {
        fn read(& mut self, buf: &mut [u8]) -> Result<usize, io::Error> {
            // return two byte at a tim e
            if buf.len() >= 2 {
                self.underlying_reader.read(&mut buf[..2])
            } else {
                self.underlying_reader.read(&mut buf[..])
            }
        }
    }

    mod test_read_full {

        #[test]
        fn test_read_full_slow() {
            let mut underlying_data: &[u8] = &[0, 1, 2, 3, 4, 5, 6, 7];
            let mut reader = super::SlowReader {
                underlying_reader: &mut underlying_data,
            };
            let mut buf = vec![0u8; 4];
            let res = super::lib::read_full(&mut buf[..4], &mut reader);
            assert_eq!(res.unwrap(), 4usize);
            assert_eq!(buf[..4], [0, 1, 2, 3]);
            let res = super::lib::read_full(&mut buf[..3], &mut reader);
            assert_eq!(res.unwrap(), 3usize);
            assert_eq!(buf[..3], [4, 5, 6]);
            let res = super::lib::read_full(&mut buf[..3], &mut reader);
            assert_eq!(res.unwrap(), 1usize);
            assert_eq!(buf[0], 7);
        }

        #[test]
        fn test_read_full_once() {
            let mut underlying_data: &[u8] = &[0, 1, 2, 3, 4, 5, 6, 7];
            let mut buf = vec![0u8; 9];
            let res = super::lib::read_full(&mut buf[..], &mut underlying_data);
            assert_eq!(res.unwrap(), 8usize);
        }
    }

    mod test_metering_reader {
        use std::io;
        use crate::{MeteringReader, BlackHole};
        use std::sync::{Arc};

        #[test]
        fn test_metering_reader_update() {
            let mut input = "123456".as_bytes();
            let input_len = input.len();
            let mut meter = MeteringReader::new(&mut input);
            let mut meter_reader = meter.as_reader();
            io::copy(&mut meter_reader, &mut BlackHole{}).unwrap();
            let result = meter.get_counter();
            assert_eq!(input_len, result);
        }

        #[test]
        fn test_metering_drop_counter_when_meter_is_dropped() {
            let counter_ref;
            {
                let mut input = "123456".as_bytes();
                let input_len = input.len();
                let mut meter = MeteringReader::new(&mut input);
                counter_ref = Arc::downgrade(&meter.counter);
                let mut meter_reader = meter.as_reader();
                io::copy(&mut meter_reader, &mut BlackHole{}).unwrap();
                let result = meter.get_counter();
                assert_eq!(input_len, result);
            }
            assert_eq!(counter_ref.upgrade().is_none(), true);
        }
    }
}