feat: add fs::read_dir::DirEntry with precompose_unicode support.

It's available with the `fs-read-dir` feature toggle.

Author: Byron

gix-features/Cargo.toml

@@ -27,6 +27,9 @@ progress-unit-bytes = ["dep:bytesize", "prodash?/unit-bytes"]
 ## If set, walkdir iterators will be multi-threaded.
 fs-walkdir-parallel = [ "dep:jwalk", "dep:gix-utils" ]
 
+## Provide utilities suitable for working with the `std::fs::read_dir()`.
+fs-read-dir = ["dep:gix-utils"]
+
 ## Implement `tracing` with `tracing-core`, which provides applications with valuable performance details if they opt-in to it.
 ##
 ## Note that this may have overhead as well, thus instrumentations should be used stategically, only providing coarse tracing by default and adding details

gix-features/src/fs.rs

@@ -21,7 +21,7 @@ mod shared {
     }
 }
 
-#[cfg(any(feature = "walkdir", feature = "fs-walkdir-parallel"))]
+#[cfg(any(feature = "walkdir", feature = "fs-walkdir-parallel", feature = "fs-read-dir"))]
 mod walkdir_precompose {
     use std::borrow::Cow;
     use std::ffi::OsStr;
@@ -83,11 +83,13 @@ mod walkdir_precompose {
 
     /// A platform over entries in a directory, which may or may not precompose unicode after retrieving
     /// paths from the file system.
+    #[cfg(any(feature = "walkdir", feature = "fs-walkdir-parallel"))]
     pub struct WalkDir<T> {
         pub(crate) inner: Option<T>,
         pub(crate) precompose_unicode: bool,
     }
 
+    #[cfg(any(feature = "walkdir", feature = "fs-walkdir-parallel"))]
     pub struct WalkDirIter<T, I, E>
     where
         T: Iterator<Item = Result<I, E>>,
@@ -97,6 +99,7 @@ mod walkdir_precompose {
         pub(crate) precompose_unicode: bool,
     }
 
+    #[cfg(any(feature = "walkdir", feature = "fs-walkdir-parallel"))]
     impl<T, I, E> Iterator for WalkDirIter<T, I, E>
     where
         T: Iterator<Item = Result<I, E>>,
@@ -112,6 +115,32 @@ mod walkdir_precompose {
     }
 }
 
+///
+#[cfg(feature = "fs-read-dir")]
+pub mod read_dir {
+    use std::borrow::Cow;
+    use std::ffi::OsStr;
+    use std::fs::FileType;
+    use std::path::Path;
+
+    /// A directory entry adding precompose-unicode support to [`std::fs::DirEntry`].
+    pub type DirEntry = super::walkdir_precompose::DirEntry<std::fs::DirEntry>;
+
+    impl super::walkdir_precompose::DirEntryApi for std::fs::DirEntry {
+        fn path(&self) -> Cow<'_, Path> {
+            self.path().into()
+        }
+
+        fn file_name(&self) -> Cow<'_, OsStr> {
+            self.file_name().into()
+        }
+
+        fn file_type(&self) -> std::io::Result<FileType> {
+            self.file_type()
+        }
+    }
+}
+
 ///
 #[cfg(feature = "fs-walkdir-parallel")]
 pub mod walkdir {

justfile

@@ -95,6 +95,7 @@ check:
     cargo check -p gix-features --all-features
     cargo check -p gix-features --features parallel
     cargo check -p gix-features --features fs-walkdir-parallel
+    cargo check -p gix-features --features fs-read-dir
     cargo check -p gix-features --features rustsha1
     cargo check -p gix-features --features fast-sha1
     cargo check -p gix-features --features progress