Skip to content

Asynchronous tailing library in Rust

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

jmagnuson/linemux

Repository files navigation

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.3"

Feature flags

Note that building with default-features: false must also be coupled with activating a desired runtime (currently just tokio, but eventually others will be supported).

  • tokio: Use the tokio runtime (default).

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.60 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.