gix-fs 0.24.0

A crate providing file system specific utilities to `gitoxide`
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

use std::{borrow::Cow, ffi::OsStr, path::Path};

#[derive(Debug)]
pub struct DirEntry<T: std::fmt::Debug> {
    inner: T,
    precompose_unicode: bool,
}

impl<T: std::fmt::Debug> DirEntry<T> {
    /// Create a new instance.
    pub fn new(inner: T, precompose_unicode: bool) -> Self {
        Self {
            inner,
            precompose_unicode,
        }
    }
}

pub trait DirEntryApi {
    fn path(&self) -> Cow<'_, Path>;
    fn file_name(&self) -> Cow<'_, OsStr>;
    fn file_type(&self) -> std::io::Result<std::fs::FileType>;
}

impl<T: DirEntryApi + std::fmt::Debug> DirEntry<T> {
    /// Obtain the full path of this entry, possibly with precomposed unicode if enabled.
    ///
    /// Note that decomposing filesystem like those made by Apple accept both precomposed and
    /// decomposed names, and consider them equal.
    pub fn path(&self) -> Cow<'_, Path> {
        let path = self.inner.path();
        if self.precompose_unicode {
            gix_utils::str::precompose_path(path)
        } else {
            path
        }
    }

    /// Obtain the file name of this entry, possibly with precomposed Unicode if enabled.
    pub fn file_name(&self) -> Cow<'_, OsStr> {
        let name = self.inner.file_name();
        if self.precompose_unicode {
            gix_utils::str::precompose_os_string(name)
        } else {
            name
        }
    }

    /// Return the file type for the file that this entry points to.
    ///
    /// If `follow_links` was `true`, this is the file type of the item the link points to.
    pub fn file_type(&self) -> std::io::Result<std::fs::FileType> {
        self.inner.file_type()
    }
}

/// A platform over entries in a directory, which may or may not precompose unicode after retrieving
/// paths from the file system.
#[cfg(feature = "walkdir")]
pub struct WalkDir<T> {
    pub(crate) inner: Option<T>,
    pub(crate) precompose_unicode: bool,
}

#[cfg(feature = "walkdir")]
pub struct WalkDirIter<T, I, E>
where
    T: Iterator<Item = Result<I, E>>,
    I: DirEntryApi,
{
    pub(crate) inner: T,
    pub(crate) precompose_unicode: bool,
}

#[cfg(feature = "walkdir")]
impl<T, I, E> Iterator for WalkDirIter<T, I, E>
where
    T: Iterator<Item = Result<I, E>>,
    I: DirEntryApi + std::fmt::Debug,
{
    type Item = Result<DirEntry<I>, E>;

    fn next(&mut self) -> Option<Self::Item> {
        self.inner
            .next()
            .map(|res| res.map(|entry| DirEntry::new(entry, self.precompose_unicode)))
    }
}