#watcher #file-watcher #events #notify #async #trigger #debouncing

async-watcher

Trigger events when files or directories change

5 unstable releases

0.3.0 May 17, 2024
0.2.1 Mar 30, 2024
0.2.0 Sep 19, 2023
0.1.1 Jun 24, 2023
0.1.0 Jun 24, 2023

#12 in #trigger

Download history 17/week @ 2024-06-30 1/week @ 2024-07-07 15/week @ 2024-07-14 5/week @ 2024-07-21 7/week @ 2024-07-28 27/week @ 2024-08-11 46/week @ 2024-08-18 37/week @ 2024-08-25 31/week @ 2024-09-01 56/week @ 2024-09-08 17/week @ 2024-09-15 83/week @ 2024-09-22 56/week @ 2024-09-29 9/week @ 2024-10-06 29/week @ 2024-10-13

178 downloads per month

MIT license

15KB
251 lines

async-watcher

github crates.io docs.rs

This is a small library that uses notify to implement a file watcher that is debounced. The debouncing helps ensure you don't get too many events on a single file leading to extra work. The original use case of this was to watch a directory and rebuild when there are changes. Without debouncing, a single file could trigger multiple rebuilds. Instead, async-watcher can be used to trigger events after a specific time threshold.

Notify takes care of all of the work, but the debouncing traits weren't async. async-watcher leverages async-trait to provide an async interface for creating watchers.

See the examples for usage.

cli

Included is a command line application that can be used to execute a command when notified of changes. The files to watch are specified with a glob pattern as the first argument. Subsequent arguments are the command to run and its arguments. The program is exposed as a nix flake package called awatch.

example usage:

awatch './{crates,Cargo.toml,Cargo.lock}' echo "crates modified"

Dependencies

~4–12MB
~139K SLoC