Expand description
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:
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:
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());
Implementations
Trait Implementations
sourceimpl<R: Read, I: Iterator<Item = usize>> Read for ShortRead<R, I>
impl<R: Read, I: Iterator<Item = usize>> Read for ShortRead<R, I>
sourcefn read(&mut self, buf: &mut [u8]) -> Result<usize>
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
Pull some bytes from this source into the specified buffer, returning
how many bytes were read. Read more
1.36.0 · sourcefn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
Like
read
, except that it reads into a slice of buffers. Read moresourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
🔬This is a nightly-only experimental API. (
can_vector
)1.0.0 · sourcefn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
Read all bytes until EOF in this source, placing them into
buf
. Read more1.0.0 · sourcefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to
buf
. Read more1.6.0 · sourcefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill
buf
. Read moresourcefn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
🔬This is a nightly-only experimental API. (
read_buf
)Pull some bytes from this source into the specified buffer. Read more
sourcefn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
🔬This is a nightly-only experimental API. (
read_buf
)Read the exact number of bytes required to fill
cursor
. Read more1.0.0 · sourcefn by_ref(&mut self) -> &mut Self
fn by_ref(&mut self) -> &mut Self
Creates a “by reference” adaptor for this instance of
Read
. Read moreAuto Trait Implementations
impl<R, I> RefUnwindSafe for ShortRead<R, I>where
I: RefUnwindSafe,
R: RefUnwindSafe,
impl<R, I> Send for ShortRead<R, I>where
I: Send,
R: Send,
impl<R, I> Sync for ShortRead<R, I>where
I: Sync,
R: Sync,
impl<R, I> Unpin for ShortRead<R, I>where
I: Unpin,
R: Unpin,
impl<R, I> UnwindSafe for ShortRead<R, I>where
I: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more