pub trait AsyncRead {
// Required method
async fn read<B: IoBufMut>(&mut self, buf: B) -> BufResult<usize, B>;
// Provided method
async fn read_vectored<V: IoVectoredBufMut>(
&mut self,
buf: V,
) -> BufResult<usize, V> { ... }
}
Expand description
AsyncRead
Async read with a ownership of a buffer
Required Methods§
Sourceasync fn read<B: IoBufMut>(&mut self, buf: B) -> BufResult<usize, B>
async fn read<B: IoBufMut>(&mut self, buf: B) -> BufResult<usize, B>
Read some bytes from this source into the IoBufMut
buffer and return
a BufResult
, consisting of the buffer and a usize
indicating
how many bytes were read.
§Caution
Implementor MUST update the buffer init via
SetBufInit::set_buf_init
after reading, and no further update should
be made by caller.
Provided Methods§
Sourceasync fn read_vectored<V: IoVectoredBufMut>(
&mut self,
buf: V,
) -> BufResult<usize, V>
async fn read_vectored<V: IoVectoredBufMut>( &mut self, buf: V, ) -> BufResult<usize, V>
Like read
, except that it reads into a type implements
IoVectoredBufMut
.
The default implementation will try to read into the buffers in order,
and stop whenever the reader returns an error, Ok(0)
, or a length
less than the length of the buf passed in, meaning it’s possible that
not all buffer space is filled. If guaranteed full read is desired,
it is recommended to use AsyncReadExt::read_vectored_exact
instead.
§Caution
Implementor MUST update the buffer init via
SetBufInit::set_buf_init
after reading.
Dyn Compatibility§
This trait is not dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.