Struct ShortRead

Source
pub struct ShortRead<R, I> { /* private fields */ }
Expand description

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());

Implementations§

Source§

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

Source

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

Source

pub fn into_inner(self) -> R

Trait Implementations§

Source§

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

Source§

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

Attempt to read from the AsyncRead into buf. Read more
Source§

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. Read more
Source§

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

Auto Trait Implementations§

§

impl<R, I> Freeze for ShortRead<R, I>
where R: Freeze, I: Freeze,

§

impl<R, I> RefUnwindSafe for ShortRead<R, I>

§

impl<R, I> Send for ShortRead<R, I>
where R: Send, I: Send,

§

impl<R, I> Sync for ShortRead<R, I>
where R: Sync, I: Sync,

§

impl<R, I> UnwindSafe for ShortRead<R, I>
where R: UnwindSafe, I: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<R> AsyncReadExt for R
where R: AsyncRead + ?Sized,

Source§

fn chain<R>(self, next: R) -> Chain<Self, R>
where Self: Sized, R: AsyncRead,

Creates an adaptor which will chain this stream with another. Read more
Source§

fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>
where Self: Unpin,

Tries to read some bytes directly into the given buf in asynchronous manner, returning a future type. Read more
Source§

fn read_vectored<'a>( &'a mut self, bufs: &'a mut [IoSliceMut<'a>], ) -> ReadVectored<'a, Self>
where Self: Unpin,

Creates a future which will read from the AsyncRead into bufs using vectored IO operations. Read more
Source§

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>
where Self: Unpin,

Creates a future which will read exactly enough bytes to fill buf, returning an error if end of file (EOF) is hit sooner. Read more
Source§

fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>
where Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more
Source§

fn read_to_string<'a>( &'a mut self, buf: &'a mut String, ) -> ReadToString<'a, Self>
where Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more
Source§

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)
where Self: Sized + AsyncWrite,

Helper method for splitting this read/write object into two halves. Read more
Source§

fn take(self, limit: u64) -> Take<Self>
where Self: Sized,

Creates an AsyncRead adapter which will read at most limit bytes from the underlying reader. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.