watch_dir 1.0.0

Monitors a directory for file changes and delivers new UTF-8 content over a channel, with configurable read strategies.
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

use std::fmt::{Display, Formatter};

/// The category of a [`WatchDirError`].
#[derive(Debug)]
pub enum ErrorKind {
    /// An error from the underlying `notify` filesystem watcher.
    Notify(notify::Error),
    /// An I/O error encountered while reading a file or scanning a directory.
    Io(std::io::Error),
}

/// Error type returned by this crate.
///
/// Use [`WatchDirError::kind`] to inspect the underlying cause.
#[derive(Debug)]
pub struct WatchDirError {
    kind: ErrorKind,
}

impl WatchDirError {
    /// Returns the underlying [`ErrorKind`].
    pub fn kind(&self) -> &ErrorKind {
        &self.kind
    }
}

impl Display for WatchDirError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match &self.kind {
            ErrorKind::Notify(e) => write!(f, "notify error: {}", e),
            ErrorKind::Io(e) => write!(f, "io error: {}", e),
        }
    }
}

impl From<notify::Error> for WatchDirError {
    fn from(e: notify::Error) -> Self {
        Self {
            kind: ErrorKind::Notify(e),
        }
    }
}

impl From<std::io::Error> for WatchDirError {
    fn from(e: std::io::Error) -> Self {
        Self {
            kind: ErrorKind::Io(e),
        }
    }
}