#tail #log #watch #fs #events

linemux

A library providing asynchronous, multiplexed tailing for (namely log) files

4 releases

0.1.3 Nov 22, 2020
0.1.2 Nov 8, 2020
0.1.1 Apr 17, 2020
0.1.0 Apr 10, 2020

#173 in Asynchronous

Download history 41/week @ 2020-11-07 15/week @ 2020-11-14 50/week @ 2020-11-21 20/week @ 2020-11-28 30/week @ 2020-12-05 25/week @ 2020-12-12 14/week @ 2020-12-19 9/week @ 2020-12-26 18/week @ 2021-01-02 15/week @ 2021-01-09 24/week @ 2021-01-16 14/week @ 2021-01-23 7/week @ 2021-01-30 14/week @ 2021-02-06 67/week @ 2021-02-13 14/week @ 2021-02-20

75 downloads per month
Used in 2 crates

MIT/Apache

49KB
996 lines

linemux

Build Status Crate API Coverage

A library providing asynchronous, multiplexed tailing for (namely log) files.

Also available is the underlying file event-stream (driven by notify) that can register non-existent files.

Usage

Add linemux to your Cargo.toml with:

[dependencies]
linemux = "0.1"

Example

use linemux::MuxedLines;

#[tokio::main]
async fn main() -> std::io::Result<()> {
    let mut lines = MuxedLines::new()?;

    // Register some files to be tailed, whether they currently exist or not.
    lines.add_file("some/file.log").await?;
    lines.add_file("/some/other/file.log").await?;

    // Wait for `Line` event, which contains the line captured for a given
    // source path.
    while let Ok(Some(line)) = lines.next_line().await {
        println!("source: {}, line: {}", line.source().display(), line.line());
    }
    Ok(())
}

Caveats

Currently, linemux assumes that if a nonexistent file is added, its parent does at least exist to register a directory watch with notify. This is done for performance reasons and to simplify the pending-watch complexity (such as limiting recursion and fs event spam). However, this may change if a need presents itself.

Minimum Supported Rust Version (MSRV)

This crate is guaranteed to compile on stable Rust 1.40 and up.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~3.5MB
~59K SLoC