Struct aiowrap::ShortRead

pub struct ShortRead<R, I> { /* fields omitted */ }

Intentionally return short reads, to test AsyncRead code.

The decider iterator gets to decide how short a read should be. A read length of 0 generates an Poll::Pending, with an immediate wakeup. 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:

use futures::io;
use futures::io::AsyncReadExt as _;
let mut naughty = aiowrap::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).await.unwrap());

Methods

impl<R, I: Iterator<Item = usize>> ShortRead<R, I>

pub fn new(inner: R, decider: I) -> Self

pub fn into_inner(self) -> R

Trait Implementations

impl<R: AsyncRead, I: Iterator<Item = usize>> AsyncRead for ShortRead<R, I>

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<'__pin, R, I> Unpin for ShortRead<R, I> where
    __Origin<'__pin, R, I>: Unpin,