file-engine 1.1.1

Async, cross-platform file operations engine for desktop apps and developer tools: copy, move, sync, watch, and compress files with progress reporting and cancellation.
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use std::path::PathBuf;

/// See dev-docs/design/watch.md. A thin wrapper rather than a re-export of
/// `notify::Event` — insulates the public API from `notify`'s types and
/// version, at the cost of collapsing its more granular sub-kinds
/// (`Create(CreateKind::File/Folder/...)`, etc.) into what most consumers
/// actually branch on.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum WatchEventKind {
    Created,
    Modified,
    Removed,
    Other,
}

#[derive(Debug, Clone)]
pub struct WatchEvent {
    pub kind: WatchEventKind,
    pub paths: Vec<PathBuf>,
}

impl From<notify::Event> for WatchEvent {
    fn from(event: notify::Event) -> Self {
        let kind = match event.kind {
            notify::EventKind::Create(_) => WatchEventKind::Created,
            notify::EventKind::Modify(_) => WatchEventKind::Modified,
            notify::EventKind::Remove(_) => WatchEventKind::Removed,
            notify::EventKind::Access(_) | notify::EventKind::Other | notify::EventKind::Any => {
                WatchEventKind::Other
            }
        };
        WatchEvent { kind, paths: event.paths }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn event(kind: notify::EventKind) -> notify::Event {
        notify::Event { kind, paths: vec![PathBuf::from("a")], attrs: Default::default() }
    }

    #[test]
    fn create_variants_collapse_to_created() {
        for kind in [
            notify::EventKind::Create(notify::event::CreateKind::File),
            notify::EventKind::Create(notify::event::CreateKind::Folder),
            notify::EventKind::Create(notify::event::CreateKind::Any),
        ] {
            assert_eq!(WatchEvent::from(event(kind)).kind, WatchEventKind::Created);
        }
    }

    #[test]
    fn modify_variants_collapse_to_modified() {
        for kind in [
            notify::EventKind::Modify(notify::event::ModifyKind::Data(notify::event::DataChange::Any)),
            notify::EventKind::Modify(notify::event::ModifyKind::Name(notify::event::RenameMode::Any)),
            notify::EventKind::Modify(notify::event::ModifyKind::Any),
        ] {
            assert_eq!(WatchEvent::from(event(kind)).kind, WatchEventKind::Modified);
        }
    }

    #[test]
    fn remove_variants_collapse_to_removed() {
        for kind in [
            notify::EventKind::Remove(notify::event::RemoveKind::File),
            notify::EventKind::Remove(notify::event::RemoveKind::Folder),
            notify::EventKind::Remove(notify::event::RemoveKind::Any),
        ] {
            assert_eq!(WatchEvent::from(event(kind)).kind, WatchEventKind::Removed);
        }
    }

    #[test]
    fn access_other_and_any_collapse_to_other() {
        for kind in [
            notify::EventKind::Access(notify::event::AccessKind::Any),
            notify::EventKind::Other,
            notify::EventKind::Any,
        ] {
            assert_eq!(WatchEvent::from(event(kind)).kind, WatchEventKind::Other);
        }
    }

    #[test]
    fn paths_round_trip_unchanged() {
        let notify_event = event(notify::EventKind::Any);
        let expected = notify_event.paths.clone();
        assert_eq!(WatchEvent::from(notify_event).paths, expected);
    }
}