anotify 0.1.3

Async iNotify Filesystem Watcher
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

use std::{
    fmt::{Display, Formatter},
    future::Future,
    pin::Pin,
};

use nix::sys::inotify::{AddWatchFlags, WatchDescriptor};
use tokio::sync::oneshot::Receiver as OnceRecv;
use tokio_stream::{wrappers::ReceiverStream, Stream};

use crate::handle::Handle;

#[derive(Debug, Clone, Copy, PartialEq)]
pub enum FileWatchEvent {
    Read,
    Write,
    Open,
    Close { writable: bool },
}

impl TryFrom<AddWatchFlags> for FileWatchEvent {
    type Error = String;

    fn try_from(it: AddWatchFlags) -> Result<Self, Self::Error> {
        use FileWatchEvent::*;
        match it {
            AddWatchFlags::IN_ACCESS => Ok(Read),
            AddWatchFlags::IN_MODIFY => Ok(Write),
            AddWatchFlags::IN_OPEN => Ok(Open),
            AddWatchFlags::IN_CLOSE_NOWRITE => Ok(Close { writable: false }),
            AddWatchFlags::IN_CLOSE_WRITE => Ok(Close { writable: true }),
            otherwise => Err(format!(
                "FileWatchEvent does not cover the bitpattern 0x{otherwise:8X}"
            )),
        }
    }
}

impl Display for FileWatchEvent {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        use FileWatchEvent::*;
        match *self {
            Read => write!(f, "read"),
            Write => write!(f, "written"),
            Open => write!(f, "opened"),
            Close { writable } => write!(
                f,
                "closed {}",
                if writable {
                    "for reading"
                } else {
                    "for writing"
                }
            ),
        }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct DirectoryWatchEvent {
    pub inner_path: Option<String>,
    pub event: FileWatchEvent,
}

impl Display for DirectoryWatchEvent {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        if let Some(ref inner_path) = self.inner_path {
            write!(f, "{inner_path} was {}", self.event)
        } else {
            write!(f, "a file was {}", self.event)
        }
    }
}

/// Single Event File Watch
pub struct FileWatchFuture {
    pub(crate) inner: OnceRecv<DirectoryWatchEvent>,
    pub(crate) watch_token: WatchDescriptor,
    pub(crate) handle: Handle,
    pub(crate) closed: bool,
}
pub struct FileWatchStream {
    pub(crate) inner: ReceiverStream<DirectoryWatchEvent>,
    pub(crate) watch_token: WatchDescriptor,
    pub(crate) handle: Handle,
}
pub struct DirectoryWatchFuture {
    pub(crate) inner: OnceRecv<DirectoryWatchEvent>,
    pub(crate) watch_token: WatchDescriptor,
    pub(crate) handle: Handle,
    pub(crate) closed: bool,
}
pub struct DirectoryWatchStream {
    pub(crate) inner: ReceiverStream<DirectoryWatchEvent>,
    pub(crate) watch_token: WatchDescriptor,
    pub(crate) handle: Handle,
}

impl Future for FileWatchFuture {
    type Output = Option<FileWatchEvent>;

    fn poll(
        mut self: std::pin::Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Self::Output> {
        Pin::new(&mut self.inner)
            .poll(cx)
            .map(|it| it.ok().map(|event| event.event))
    }
}

impl Future for DirectoryWatchFuture {
    type Output = Option<DirectoryWatchEvent>;

    fn poll(
        mut self: Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Self::Output> {
        Pin::new(&mut self.inner).poll(cx).map(|it| it.ok())
    }
}

impl Stream for FileWatchStream {
    type Item = FileWatchEvent;

    fn poll_next(
        mut self: Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Option<Self::Item>> {
        Pin::new(&mut self.inner)
            .poll_next(cx)
            .map(|it| it.map(|event| event.event))
    }
}

impl Stream for DirectoryWatchStream {
    // TODO(josiah) update this so that the item type can be WatchResult<WatchEvent>
    type Item = DirectoryWatchEvent;

    fn poll_next(
        mut self: Pin<&mut Self>,
        cx: &mut std::task::Context<'_>,
    ) -> std::task::Poll<Option<Self::Item>> {
        Pin::new(&mut self.inner).poll_next(cx)
    }
}