pub trait AsyncBufReadWith<'a>: AsyncReadWith<'a> {
type FillBufFuture: CompletionFuture<Output = Result<&'a [u8]>>;
// Required methods
fn fill_buf(&'a mut self) -> Self::FillBufFuture;
fn consume(&mut self, amt: usize);
}Expand description
Read bytes from a source that has an internal buffer asynchronously with a specific lifetime.
Required Associated Types§
Sourcetype FillBufFuture: CompletionFuture<Output = Result<&'a [u8]>>
type FillBufFuture: CompletionFuture<Output = Result<&'a [u8]>>
Future that returns the contents of the internal buffer.
Required Methods§
Sourcefn fill_buf(&'a mut self) -> Self::FillBufFuture
fn fill_buf(&'a mut self) -> Self::FillBufFuture
Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.
This function is a lower-level call. It needs to be paired with the consume method to
function properly. When calling this method, none of the contents will be “read” in the
sense that later calling read may return the same contents. As such, consume must be
called with the number of bytes that are consumed from this buffer to ensure that the bytes
are never returned twice.
An empty buffer returned indicates that the stream has reached EOF.
§Errors
This function will return an I/O error if the underlying reader was read, but returned an error.
Sourcefn consume(&mut self, amt: usize)
fn consume(&mut self, amt: usize)
Tell this buffer that amt bytes have been consumed from the buffer, and so should no
longer be returned in calls to read.
This function is a lower-level call. It needs to be paired with the fill_buf method to
function properly. This function does not perform any I/O, it simply informs this object
that some amount of its buffer, returned from fill_buf, has been consumed and should no
longer be returned. As such, this function may do odd things if fill_buf isn’t called
before calling it.
The amt must be <= the number of bytes in the buffer returned by fill_buf.