dir_watcher 1.2.0

Simple crate for monitoring directories for changes
Documentation 
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# Dir Watcher

Dir Watcher is a small Rust library for monitoring filesystem events on a directory.
It wraps the [`notify`](https://docs.rs/notify/) crate and exposes an async API
for receiving change events via a Tokio `mpsc` channel.

## Features

- Monitor a directory recursively or non-recursively.
- Ignore specific subdirectories.
- Choose which events to track (all events, file modifications only or file access events).
- Built with Tokio and `notify` and can be integrated in asynchronous applications.

## Installation

Add the crate to your `Cargo.toml`:

```toml
[dependencies]
dir_watcher = "1.1.0"
```

## Quick start

```rust
use dir_watcher::{Options, RawFileMonitor, MonitorMode, RecursiveMode};
use dusa_collection_utils::core::types::pathtype::PathType;

#[tokio::main]
async fn main() {
    let mut options = Options::default();
    options
        .set_target_dir(PathType::Str("/tmp".into()))
        .set_interval(30)
        .set_mode(RecursiveMode::Recursive)
        .set_monitor_mode(MonitorMode::ALL);

    let watcher = RawFileMonitor::new(options).await;
    watcher.start().await;

    // subscribe() returns an optional `dir_receiver<Event>`
    if let Some(mut rx) = watcher.subscribe().await {
        while let Ok(event) = rx.recv().await {
            println!("{event:#?}");
        }
    }
}
```

## Options

`Options` provides a builder style API for configuring a watcher. You can set the
base directory, scan interval, whether the watcher validates the directory on
startup and which subdirectories or events to ignore.

## License

This project is released under the MIT license. See [LISCENSE](./LISCENSE) for
more information.