walkthrough 0.1.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

use std::{
    fs,
    os::unix::{
        ffi::OsStrExt,
        fs::{DirEntryExt, MetadataExt},
    },
    path::PathBuf,
};

use once_cell::sync::OnceCell;

use super::entry::DirEntry;
use crate::Error;

impl DirEntry {
    /// Returns the metadata for this entry.
    pub fn metadata(&self) -> Result<fs::Metadata, Error> {
        self.metadata
            .get_or_try_init(|| {
                if self.follow_link {
                    fs::metadata(self.path())
                } else {
                    fs::symlink_metadata(self.path())
                }
                .map_err(|err| Error::from_entry(self, err))
            })
            .map(|m| m.to_owned())
    }

    /// Returns `true` if this entry is hidden (name starts with `.`).
    pub fn is_hidden(&self) -> bool {
        self.file_name().as_bytes().starts_with(b".")
    }

    pub(crate) fn from_path(path: PathBuf, depth: usize, follow_link: bool) -> Result<Self, Error> {
        let raw = fs::symlink_metadata(&path)
            .map_err(|err| Error::new_io_error(path.clone(), depth, err))?;
        let mut file_type = raw.file_type();
        let mut ino = raw.ino();
        let metadata = OnceCell::new();
        if file_type.is_dir() || file_type.is_symlink() && follow_link {
            let resolved =
                fs::metadata(&path).map_err(|err| Error::new_io_error(path.clone(), depth, err))?;
            file_type = resolved.file_type();
            ino = resolved.ino();
            metadata.set(resolved).unwrap();
        } else {
            metadata.set(raw).unwrap();
        }
        Ok(Self {
            path,
            file_type,
            follow_link,
            depth,
            ino,
            metadata,
        })
    }

    pub(crate) fn from_std(
        entry: &fs::DirEntry,
        depth: usize,
        follow_link: bool,
    ) -> Result<Self, Error> {
        let path = entry.path();
        let mut file_type = entry
            .file_type()
            .map_err(|err| Error::new_io_error(path.clone(), depth, err))?;
        let mut ino = entry.ino();
        let metadata = OnceCell::new();
        if file_type.is_dir() || file_type.is_symlink() && follow_link {
            let resolved_metadata =
                fs::metadata(&path).map_err(|err| Error::new_io_error(path.clone(), depth, err))?;
            file_type = resolved_metadata.file_type();
            ino = resolved_metadata.ino();
            metadata.set(resolved_metadata).unwrap();
        }

        Ok(Self {
            path,
            file_type,
            follow_link,
            depth,
            ino,
            metadata,
        })
    }

    pub(crate) fn ancestor(&self) -> Option<Ancestor> {
        let metadata = self.metadata().ok()?;
        Some(Ancestor {
            dev: metadata.dev(),
            ino: metadata.ino(),
        })
    }
}

impl DirEntryExt for DirEntry {
    fn ino(&self) -> u64 {
        self.ino
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub(crate) struct Ancestor {
    pub(super) dev: u64,
    pub(super) ino: u64,
}