#non-blocking #io #read #line #object #buffered #reader

lineriver

Non-blocking buffered line reader for Read objects

8 releases (breaking)

0.7.1 Feb 17, 2024
0.7.0 Sep 6, 2023
0.6.0 Sep 5, 2023
0.5.0 Sep 5, 2023
0.1.0 Jul 22, 2023

#680 in Filesystem

37 downloads per month
Used in stdecor

MIT license

17KB
167 lines

CI coveralls crates.io doc.rs

lineriver

lineriver is a rust crate that provides a non-blocking buffered line reader for Read objects.

The LineReader object is akin to a BufReader object that returns only complete lines, but without blocking. The LineRead trait, on the other hand, is akin to the BufRead trait - it concentrates the public API and allows us to create agnostic collections of LineReaders with distinct underlying types.

This crate works very well with the polling crate, which allows us to block waiting on data to be available in any one of multiple streams (files, sockets, etc.). It's an alternative to using threads and/or tokio.

See LineReader for details.

Usage

The simplest way to explain how to use LineReader is with a busy-loop example:

use lineriver::{LineReader, LineRead};

let mut linereader = LineReader::new(reader)?;
while !linereader.eof() {
    linereader.read_available()?;
    let lines = linereader.lines_get();
    for line in lines {
        print!("{}", line);
    }
}

Dependencies

~485–770KB
~12K SLoC