3 releases (breaking)

0.3.0 Jul 29, 2024
0.2.0 Jul 13, 2024
0.1.0 May 21, 2023

#450 in Filesystem

Download history 574/week @ 2024-08-15 627/week @ 2024-08-22 1053/week @ 2024-08-29 1278/week @ 2024-09-05 668/week @ 2024-09-12 622/week @ 2024-09-19 979/week @ 2024-09-26 418/week @ 2024-10-03 377/week @ 2024-10-10 556/week @ 2024-10-17 502/week @ 2024-10-24 377/week @ 2024-10-31 641/week @ 2024-11-07 2188/week @ 2024-11-14 427/week @ 2024-11-21 400/week @ 2024-11-28

3,694 downloads per month
Used in 6 crates (via breezyshim)

Apache-2.0

20KB
383 lines

Opportunistic dirty file tracker

This library provides a simple way to track dirty files in a directory. It uses the notify crate to watch for file system events and keep track of the files that have been modified.

If the underlying file system does not support watching for file system events, or if there are too many files to watch, the tracker will simply give up and return State::Unknown.

Example:

use dirty_tracker::{State, DirtyTracker};

let td = tempfile::tempdir().unwrap();

let mut tracker = DirtyTracker::new(td.path()).unwrap();
assert_eq!(tracker.state(), State::Clean);
assert!(tracker.paths().unwrap().is_empty());

// Modify a file in the directory.
std::fs::write(td.path().join("file"), b"hello").unwrap();

assert_eq!(tracker.state(), State::Dirty);
assert_eq!(tracker.paths(), Some(&maplit::hashset![td.path().join("file")]));

lib.rs:

Opportunistic dirty file tracker

This library provides a simple way to track dirty files in a directory. It uses the notify crate to watch for file system events and keep track of the files that have been modified.

If the underlying file system does not support watching for file system events, or if there are too many files to watch, the tracker will simply give up and return State::Unknown.

Example

use dirty_tracker::{State, DirtyTracker};

let td = tempfile::tempdir().unwrap();

let mut tracker = DirtyTracker::new(td.path()).unwrap();
assert_eq!(tracker.state(), State::Clean);
assert!(tracker.paths().unwrap().is_empty());

// Modify a file in the directory.
std::fs::write(td.path().join("file"), b"hello").unwrap();

assert_eq!(tracker.state(), State::Dirty);
assert_eq!(tracker.paths(), Some(&maplit::hashset![td.path().join("file")]));

Dependencies

~2–14MB
~135K SLoC