walkthrough 0.2.0

A Rust crate for recursive directory traversal.
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

use std::{
    io,
    path::{Path, PathBuf},
};

use thiserror::Error;

use crate::DirEntry;

/// Distinguishes the cause of a traversal [`Error`].
#[derive(Debug, Error)]
pub enum ErrorKind {
    /// An I/O error occurred while reading a directory entry or its metadata.
    #[error("{0}")]
    Io(#[source] io::Error),

    /// Following a symlink would revisit a directory that is already an
    /// ancestor in the current traversal path.
    #[error("symlink loop detected")]
    LoopDetected,
}

/// Error produced during directory traversal.
///
/// Always carries the filesystem [`path`](Self::path) and traversal
/// [`depth`](Self::depth) at which the failure occurred, together with a
/// [`kind`](Self::kind) that distinguishes the underlying cause.
#[derive(Debug, Error)]
#[error("Error on {path} with depth {depth} and kind: {kind}")]
pub struct Error {
    path: PathBuf,
    depth: usize,
    kind: ErrorKind,
}

/// Type alias for results that may contain a traversal [`struct@Error`].
pub type Result<T, E = Error> = std::result::Result<T, E>;

impl Error {
    /// Returns the filesystem path at which this error occurred.
    #[inline]
    pub fn path(&self) -> &Path {
        &self.path
    }

    /// Returns the traversal depth at which this error occurred.
    #[inline]
    pub fn depth(&self) -> usize {
        self.depth
    }

    /// Returns the kind of this error.
    #[inline]
    pub fn kind(&self) -> &ErrorKind {
        &self.kind
    }

    /// Returns `true` if this error wraps an [`io::Error`].
    #[inline]
    pub fn is_io(&self) -> bool {
        matches!(self.kind, ErrorKind::Io(_))
    }

    /// Returns `true` if this error is a symlink loop detection.
    #[inline]
    pub fn is_loop(&self) -> bool {
        matches!(self.kind, ErrorKind::LoopDetected)
    }

    /// Returns a reference to the inner [`io::Error`], or `None` if this is
    /// not an I/O error.
    #[inline]
    pub fn io_error(&self) -> Option<&io::Error> {
        match &self.kind {
            ErrorKind::Io(e) => Some(e),
            ErrorKind::LoopDetected => None,
        }
    }

    /// Consumes `self` and returns the inner [`io::Error`], or `None` if this
    /// is not an I/O error.
    #[inline]
    pub fn into_io_error(self) -> Option<io::Error> {
        match self.kind {
            ErrorKind::Io(err) => Some(err),
            ErrorKind::LoopDetected => None,
        }
    }

    pub(crate) fn from_entry<T>(entry: &DirEntry<T>, source: io::Error) -> Self {
        Self {
            path: entry.path().to_path_buf(),
            depth: entry.depth(),
            kind: ErrorKind::Io(source),
        }
    }

    pub(crate) fn new_io_error(path: PathBuf, depth: usize, source: io::Error) -> Self {
        Self {
            path,
            depth,
            kind: ErrorKind::Io(source),
        }
    }

    pub(crate) fn loop_detected(path: PathBuf, depth: usize) -> Self {
        Self {
            path,
            depth,
            kind: ErrorKind::LoopDetected,
        }
    }
}