Trait embedded_io::asynch::Read

pub trait Read: Io {
    type ReadFuture<'a>: Future<Output = Result<usize, Self::Error>>
    where
        Self: 'a;

    fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Self::ReadFuture<'a>;

    fn read_exact<'a>(
        &'a mut self, 
        buf: &'a mut [u8]
    ) -> impl Future<Output = Result<(), ReadExactError<Self::Error>>> { ... }
}

Available on crate feature async only.

Async reader.

Semantics are the same as std::io::Read, check its documentation for details.

Required Associated Types

type ReadFuture<'a>: Future<Output = Result<usize, Self::Error>>
where
    Self: 'a

Future returned by read.

Required Methods

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

Provided Methods

fn read_exact<'a>(
    &'a mut self,
    buf: &'a mut [u8]
) -> impl Future<Output = Result<(), ReadExactError<Self::Error>>>

Read the exact number of bytes required to fill buf.

Implementations on Foreign Types

impl<T: ?Sized + Read> Read for &mut T

type ReadFuture<'a>
where
    Self: 'a = impl Future<Output = Result<usize, <&'_ mut T as Io>::Error>>

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

impl Read for &[u8]

Read is implemented for &[u8] by copying from the slice.

Note that reading updates the slice to point to the yet unread part. The slice will be empty when EOF is reached.

type ReadFuture<'a>
where
    Self: 'a = impl Future<Output = Result<usize, <&'_ [u8] as Io>::Error>>

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

impl<T: ?Sized + Read> Read for Box<T>

Available on crate features std or alloc only.

type ReadFuture<'a>
where
    Self: 'a = impl Future<Output = Result<usize, <Box<T, Global> as Io>::Error>>

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

Implementors

impl<T: AsyncRead + Unpin + ?Sized> Read for FromTokio<T>

Available on crate feature tokio only.

type ReadFuture<'a>
where
    Self: 'a = impl Future<Output = Result<usize, <FromTokio<T> as Io>::Error>>

impl<T: AsyncRead + Unpin + ?Sized> Read for FromFutures<T>

Available on crate feature futures only.

type ReadFuture<'a>
where
    Self: 'a = impl Future<Output = Result<usize, <FromFutures<T> as Io>::Error>>