feat: add byte counter #51
Conversation
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod test { |
There was a problem hiding this comment.
Another useful test could be to do multiple calls to write, in order to assert that the stored total length updates properly (and doesn't, for example, reset by mistake or something).
| use std::io; | ||
|
|
||
| #[derive(Debug, Clone, Default)] | ||
| pub struct ByteCounter { |
There was a problem hiding this comment.
Can you add brief struct- and module-level documentation to indicate the intent? In this case it's pretty obvious from inspection, but nice to have for things like IDEs that provide it.
|
|
||
| use std::{io, io::Read}; | ||
|
|
||
| pub struct LimitedBytesReader<R> { |
There was a problem hiding this comment.
Can you add brief struct- and module-level documentation to indicate the intent? In this case it's pretty obvious from inspection, but nice to have for things like IDEs that provide it.
| } | ||
| impl<R: Read> Read for LimitedBytesReader<R> { | ||
| fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> { | ||
| let read = self.inner.read(buf)?; |
There was a problem hiding this comment.
This will (attempt to) fill the buffer even in the case where too many bytes are read. Is this the desired behavior? I would have thought that if an error is raised, the caller might expect the buffer to remain untouched.
| let mut reader = LimitedBytesReader::new(3, inner); | ||
| let mut buf = [0u8; 3]; | ||
| let output = reader.read(&mut buf).unwrap(); | ||
| assert_eq!(output, buf.len()); |
There was a problem hiding this comment.
This doesn't actually check that the buffer was filled (or filled with the expected data), which would be useful to assert.
| // in case of buffer with length strictly bigger than reader byte_limit, the code should throw an error | ||
| let mut new_buf = [0u8; 4]; | ||
| let output = reader.read(&mut new_buf); | ||
| assert!(output.is_err()); |
There was a problem hiding this comment.
If the above comment about buffers and error handling is adopted, would be useful to assert that the buffer is unchanged.
Co-authored-by: Aaron Feickert <[email protected]>
Adds the byte counter that was previously in tari_core