dirscent 0.1.0

Directory descent
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

use std::fs::{FileType, Metadata};
use std::path::{Path, PathBuf};

use crate::error::Error;

/// Entries returned by the [iterator][crate::Dirscent].
pub struct DirEntry {
    path: PathBuf,
    file_type: FileType,
    follow_symlinks: bool,
}

impl DirEntry {
    /// Returns the full path to the file under the entry.
    pub fn path(&self) -> &Path {
        &self.path
    }

    /// Returns the file type of the file under the entry.
    ///
    /// This function does not traverse symlinks.
    pub fn file_type(&self) -> FileType {
        self.file_type
    }

    /// Returns the metadata for the file under the entry.
    ///
    /// Depending on the [iterator][crate::Dirscent] `follow_symlinks` option, this function is
    /// equivalent to [`std::fs::metadata`] or [`std::fs::symlink_metadata`].
    pub fn metadata(&self) -> Result<Metadata, Error> {
        if self.follow_symlinks {
            self.path.metadata()
        } else {
            self.path.symlink_metadata()
        }
        .map_err(|err| Error::new(err, self.path.clone()))
    }

    /// Sets whether the directory entry follows symlinks.
    ///
    /// If the argument is `true`, symlinks are followed.
    pub fn with_follow_symlinks(mut self, x: bool) -> Self {
        self.follow_symlinks = x;
        self
    }
}

impl TryFrom<std::fs::DirEntry> for DirEntry {
    type Error = Error;

    fn try_from(entry: std::fs::DirEntry) -> Result<Self, Self::Error> {
        let path = entry.path();
        match entry.file_type() {
            Ok(file_type) => Ok(DirEntry {
                path,
                file_type,
                follow_symlinks: false,
            }),
            Err(err) => Err(Error::new(err, path)),
        }
    }
}

impl TryFrom<PathBuf> for DirEntry {
    type Error = Error;

    fn try_from(path: PathBuf) -> Result<Self, Self::Error> {
        match path.symlink_metadata().map(|m| m.file_type()) {
            Ok(file_type) => Ok(DirEntry {
                path,
                file_type,
                follow_symlinks: false,
            }),
            Err(err) => Err(Error::new(err, path)),
        }
    }
}