Function tokio_util::io::read_buf

source · 
pub async fn read_buf<R, B>(read: &mut R, buf: &mut B) -> Result<usize>
where
    R: AsyncRead + Unpin,
    B: BufMut,
Available on crate feature io only.
Expand description

Read data from an AsyncRead into an implementer of the BufMut trait.

§Example

use bytes::{Bytes, BytesMut};
use tokio_stream as stream;
use tokio::io::Result;
use tokio_util::io::{StreamReader, read_buf};

// Create a reader from an iterator. This particular reader will always be
// ready.
let mut read = StreamReader::new(stream::iter(vec![Result::Ok(Bytes::from_static(&[0, 1, 2, 3]))]));

let mut buf = BytesMut::new();
let mut reads = 0;

loop {
    reads += 1;
    let n = read_buf(&mut read, &mut buf).await?;

    if n == 0 {
        break;
    }
}

// one or more reads might be necessary.
assert!(reads >= 1);
assert_eq!(&buf[..], &[0, 1, 2, 3]);