scankit 0.2.2

Walk + watch + filter directory trees. The shared scanner Tauri / Iced / native desktop apps reach for when they need to enumerate user files.
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

//! Error and Result types for scankit.
//!
//! All public APIs that can fail return [`Result<T>`]. Errors are
//! categorised broadly so callers can map them to user-facing
//! messages without pattern-matching on opaque strings.

use std::io;
use thiserror::Error;

/// Result alias used across the crate.
pub type Result<T> = std::result::Result<T, Error>;

/// Errors that can arise during scanning.
///
/// Marked `#[non_exhaustive]` so future minor versions can add new
/// variants (e.g. a dedicated `WatchTimeout` once the `watch`
/// feature lands) without breaking downstream `match` blocks.
/// Callers that pattern-match should always include a wildcard arm.
#[derive(Error, Debug)]
#[non_exhaustive]
pub enum Error {
    /// A glob pattern passed to [`ScanConfig::add_exclude`](crate::ScanConfig::add_exclude)
    /// was malformed (typically a stray `\` or unbalanced `[...]`).
    #[error("invalid exclude pattern: {0}")]
    InvalidExclude(String),

    /// Filesystem failure while reading a directory entry's metadata.
    /// The walker logs and skips these by default — they only
    /// surface in `Result` form when the caller asks for raw error
    /// stream via the iterator's `Err` branch.
    #[error("I/O error: {0}")]
    Io(#[from] io::Error),

    /// `walkdir`-internal failure (loop detection, permission
    /// denial, etc.). Wraps the underlying error verbatim.
    #[cfg(feature = "walk")]
    #[error("walk error: {0}")]
    Walk(#[from] walkdir::Error),

    /// Filesystem-watcher initialisation failed. Surfaces from
    /// [`Scanner::scan`](crate::Scanner::scan) when `notify` can't
    /// register the kernel-side subscription — typical causes:
    /// the root directory doesn't exist, permission denial, or the
    /// inotify watch budget is exhausted on Linux.
    #[cfg(feature = "watch")]
    #[error("watch error: {0}")]
    Watch(String),
}

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

    #[test]
    fn io_errors_convert_via_from() {
        let io_err = io::Error::new(io::ErrorKind::NotFound, "missing");
        let err: Error = io_err.into();
        assert!(matches!(err, Error::Io(_)));
    }

    #[test]
    fn invalid_exclude_renders_message() {
        let err = Error::InvalidExclude("`[unbalanced`: ...".into());
        assert!(err.to_string().contains("invalid exclude"));
    }
}