1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
//! A library providing asynchronous, multiplexed tailing for (namely log) files. //! //! Also available is the underlying file event-stream (driven by [`notify`](https://crates.io/crates/notify)) //! that can register non-existent files. //! //! ## Example //! //! ```no_run //! use linemux::MuxedLines; //! # use tokio_ as tokio; //! //! #[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. mod events; mod reader; pub use events::MuxedEvents; pub use reader::{Line, MuxedLines}; // FIXME: would otherwise need to expose the `tokio_` rename in docs // #[cfg(doctest)] // doc_comment::doctest!("../README.md");