4 releases

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

#1008 in Filesystem

Download history 34/week @ 2024-02-19 13/week @ 2024-02-26 5/week @ 2024-03-04 29/week @ 2024-03-11 46/week @ 2024-03-18 221/week @ 2024-03-25 48/week @ 2024-04-01 8/week @ 2024-04-08 55/week @ 2024-04-22

264 downloads per month

MIT license

14KB
246 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–14MB
~145K SLoC