dirx 0.1.0

Creates an in-memory index of all the files in a directory tree, and allows efficient scanning of only those files that have been modified since the index got created
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
149
150
151
152
153
154
155
156
157
158
159
160
161

use std::error;
use std::fmt;
use std::io;
use std::path::Path;
use std::path::PathBuf;

#[cfg(feature = "unstable")]
type RawOsError = io::RawOsError;

#[cfg(not(feature = "unstable"))]
type RawOsError = i32;

#[derive(Debug)]
pub struct Error {
    path: PathBuf,
    operation: ErrorOperation,
    source: io::Error,
}

#[derive(Copy, Clone, Debug)]
pub enum ErrorOperation {
    OpenFile,
    OpenDirectory,
    ReadDirectory,
    ReadMetadata,
    GenerateData,
}

impl Error {
    #[inline]
    pub fn from_io_error(path: PathBuf, operation: ErrorOperation, source: io::Error) -> Self {
        Self {
            path,
            operation,
            source,
        }
    }

    #[inline]
    pub fn from_raw_os_error(path: PathBuf, operation: ErrorOperation, code: RawOsError) -> Self {
        Self::from_io_error(path, operation, io::Error::from_raw_os_error(code))
    }

    #[inline]
    pub fn last_os_error(path: PathBuf, operation: ErrorOperation) -> Self {
        Self::from_io_error(path, operation, io::Error::last_os_error())
    }

    #[inline]
    pub fn path(&self) -> &Path {
        &self.path
    }

    #[inline]
    pub fn operation(&self) -> ErrorOperation {
        self.operation
    }

    #[inline]
    pub fn source(&self) -> &io::Error {
        &self.source
    }

    #[inline]
    pub fn into_source(self) -> io::Error {
        self.source
    }

    #[inline]
    pub fn into_path_source(self) -> (PathBuf, io::Error) {
        (self.path, self.source)
    }

    #[inline]
    pub fn raw_os_error(&self) -> Option<RawOsError> {
        self.source.raw_os_error()
    }

    #[inline]
    pub fn kind(&self) -> io::ErrorKind {
        self.source.kind()
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let op = match self.operation {
            ErrorOperation::OpenFile => "opening file",
            ErrorOperation::OpenDirectory => "opening directory",
            ErrorOperation::ReadDirectory => "reading directory",
            ErrorOperation::ReadMetadata => "reading metadata",
            ErrorOperation::GenerateData => "generating associated data",
        };
        write!(
            f,
            "{}: error while {}: {}",
            self.path.display(),
            op,
            self.source
        )
    }
}

impl error::Error for Error {
    #[inline]
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        Some(&self.source)
    }
}

impl From<Error> for io::Error {
    #[inline]
    fn from(err: Error) -> io::Error {
        err.source
    }
}

pub(super) trait IntoScanError {
    fn into_scan_error(self, path: PathBuf, operation: ErrorOperation) -> Error;
}

impl<T> IntoScanError for T
where
    T: Into<io::Error>,
{
    #[inline]
    fn into_scan_error(self, path: PathBuf, operation: ErrorOperation) -> Error {
        Error::from_io_error(path, operation, self.into())
    }
}

#[derive(Debug)]
pub struct FilesystemLoopError {
    start_path: PathBuf,
}

impl FilesystemLoopError {
    pub fn new(start_path: PathBuf) -> Self {
        Self { start_path }
    }

    pub fn start_path(&self) -> &Path {
        &self.start_path
    }

    pub fn into_start_path(self) -> PathBuf {
        self.start_path
    }
}

impl fmt::Display for FilesystemLoopError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "File system loop detected: this is the same file system as {}",
            self.start_path.display()
        )
    }
}

impl error::Error for FilesystemLoopError {}