yaque 0.6.6

Yaque is yet another disk-backed persistent queue for Rust
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

//! Watcher implementations for specific events on the queue directory. This is the interface with
//! the `inotify` API.

use notify::event::{Event, EventKind, ModifyKind};
use notify::{RecommendedWatcher, Watcher};
use std::path::Path;
use std::sync::{Arc, Mutex};
use std::task::Waker;

// /// Watches for the creation of a given future file.
// fn file_creation_watcher<P>(path: P, waker: Arc<Mutex<Option<Waker>>>) -> RecommendedWatcher
// where
//     P: AsRef<Path>,
// {
//     // Set up watcher:
//     let mut watcher =
//         notify::immediate_watcher(move |maybe_event: notify::Result<notify::Event>| {
//             match maybe_event.expect("received error from watcher") {
//                 // When any modification in the file happens
//                 Event {
//                     kind: EventKind::Create(_),
//                     ..
//                 } => {
//                     waker
//                         .lock()
//                         .expect("waker poisoned")
//                         .as_mut()
//                         .map(|waker: &mut Waker| waker.wake_by_ref());
//                 }
//                 _ => {}
//             }
//         })
//         .expect("could not create watcher");

//     // Put watcher to run:
//     watcher
//         .watch(
//             path.as_ref().parent().expect("file must have parent"),
//             notify::RecursiveMode::NonRecursive,
//         )
//         .expect("could not start watching file");

//     watcher
// }

/// Watches for the removal of a given future file.
pub(crate) fn file_removal_watcher<P>(
    path: P,
    waker: Arc<Mutex<Option<Waker>>>,
) -> RecommendedWatcher
where
    P: AsRef<Path>,
{
    // Set up watcher:
    let mut watcher =
        notify::recommended_watcher(move |maybe_event: notify::Result<notify::Event>| {
            match maybe_event.expect("received error from watcher") {
                // When any modification in the file happens
                Event {
                    kind: EventKind::Remove(_),
                    ..
                } => {
                    waker
                        .lock()
                        .expect("waker poisoned")
                        .take()
                        .map(|waker: Waker| waker.wake());
                }
                _ => {}
            }
        })
        .expect("could not create watcher");

    // Put watcher to run:
    watcher
        .watch(
            path.as_ref().parent().expect("file must have parent"),
            notify::RecursiveMode::NonRecursive,
        )
        .expect("could not start watching file");

    watcher
}

/// Watches *any* removal in a given path.
pub(crate) fn removal_watcher(path: &Path, waker: Arc<Mutex<Option<Waker>>>) -> RecommendedWatcher {
    // Set up watcher:
    let mut watcher =
        notify::recommended_watcher(move |maybe_event: notify::Result<notify::Event>| {
            match maybe_event.expect("received error from watcher") {
                Event {
                    kind: EventKind::Remove(_),
                    ..
                } => {
                    waker
                        .lock()
                        .expect("waker poisoned")
                        .take()
                        .map(|waker: Waker| waker.wake());
                }
                _ => {}
            }
        })
        .expect("could not create watcher");

    // Put watcher to run:
    watcher
        .watch(path, notify::RecursiveMode::NonRecursive)
        .expect("could not start watching file");

    watcher
}

/// Watches a file for changes in its content.
pub(crate) fn file_watcher(path: &Path, waker: Arc<Mutex<Option<Waker>>>) -> RecommendedWatcher {
    // Set up watcher:
    let mut watcher =
        notify::recommended_watcher(move |maybe_event: notify::Result<notify::Event>| {
            match maybe_event.expect("received error from watcher") {
                // When any modification in the file happens
                Event {
                    kind: EventKind::Modify(ModifyKind::Data(_)),
                    ..
                } => {
                    waker
                        .lock()
                        .expect("waker poisoned")
                        .take()
                        .map(|waker: Waker| waker.wake());
                }
                Event {
                    kind: EventKind::Remove(_),
                    ..
                } => {
                    log::debug!("file being watched was removed");
                }
                _ => {}
            }
        })
        .expect("could not create watcher");

    // Put watcher to run:
    watcher
        .watch(path, notify::RecursiveMode::NonRecursive)
        .expect("could not start watching file");

    watcher
}