#delimiter #slice #tokio #async-read #read-stream #async-buf-read #read-until

read_until_slice

AsyncBufRead::read_until extension to take a slice as a delimiter instead of a single u8

5 releases

new 0.1.4 May 4, 2024
0.1.3 May 3, 2024
0.1.2 Feb 18, 2024
0.1.1 Feb 18, 2024
0.1.0 Feb 18, 2024

#394 in Asynchronous

Download history 261/week @ 2024-02-18 128/week @ 2024-02-25 6/week @ 2024-03-03 1/week @ 2024-03-10 32/week @ 2024-03-31 9/week @ 2024-04-07 96/week @ 2024-04-28

105 downloads per month
Used in 3 crates (2 directly)

MIT license

9KB
103 lines

read_until_slice  LICENSE crates.io Version Documentation

The tokio io-util feature provides the method:

pub async fn read_until(&mut self, delimiter: u8, buf: Vec<u8>) -> Result<usize>

on impl AsyncBufRead + Unpin.

This reads from an async buffered reader until either EOF or the delimiter is reached.

While useful, it is limited to a single byte delimiter.

This crate extends this by taking a slice as a delimiter instead of a single byte.

pub async fn read_until_slice(&mut self, delimiter: &[u8], buf: Vec<u8>) -> Result<usize>

on the same impl AsyncBufRead + Unpin.

Example

// Open socket
let stream = TcpStream::connect(addr)
    .await
    .expect("could not connect to remote address");
// Split stream into reader and writer halves
let (reader, mut writer) = split(stream);
// Buffer read stream
let mut reader = BufReader::new(reader);
...
// Read until new line delimiter into buffer
let mut buffer = vec![];
let delimiter = b"\r\n";
let n = reader.read_until(delimiter, &mut buffer)
    .await
    .expect("could not read from socket");
assert_eq!(n, buffer.len());
if buffer.ends_with(delimiter) {
    println!("end of line delimiter reached");
} else {
    println!("end of stream reached");
}

Dependencies

~2.1–3MB
~49K SLoC