feat!: walkdir_sorted_new adds max_depth parameter

max_depth parameter determines the maximum depth the WalkDir will
recurse into.

Example values:
* 0    -> Returns only the root path with no children.
* 1    -> Returns the root path, with children.
* 2..n -> Returns the root path, children and {n}-grandchildren

Author: orthros

gix-features/src/fs.rs

@@ -207,9 +207,14 @@ pub mod walkdir {
     /// Instantiate a new directory iterator which will not skip hidden files and is sorted, with the given level of `parallelism`.
     ///
     /// Use `precompose_unicode` to represent the `core.precomposeUnicode` configuration option.
-    pub fn walkdir_sorted_new(root: &Path, _: Parallelism, precompose_unicode: bool) -> WalkDir {
+    /// Use `max_depth` to limit the depth of the recursive walk.
+    ///   * 0 -> Returns only the root path with no children
+    ///   * 1 -> Root directory and children.
+    ///   * 2..n -> Root directory, children and {n}-grandchildren
+    pub fn walkdir_sorted_new(root: &Path, _: Parallelism, max_depth: usize, precompose_unicode: bool) -> WalkDir {
         WalkDir {
             inner: WalkDirImpl::new(root)
+                .max_depth(max_depth)
                 .sort_by(|a, b| {
                     let storage_a;
                     let storage_b;

gix-ref/src/store/file/loose/iter.rs

@@ -24,6 +24,7 @@ impl SortedLoosePaths {
                 gix_features::fs::walkdir_sorted_new(
                     path,
                     gix_features::fs::walkdir::Parallelism::Serial,
+                    usize::MAX,
                     precompose_unicode,
                 )
                 .into_iter()

gix-submodule/tests/file/baseline.rs

@@ -61,7 +61,7 @@ fn common_values_and_names_by_path() -> crate::Result {
 
 fn module_files() -> impl Iterator<Item = (PathBuf, PathBuf)> {
     let dir = gix_testtools::scripted_fixture_read_only("basic.sh").expect("valid fixture");
-    gix_features::fs::walkdir_sorted_new(&dir, Parallelism::Serial, false)
+    gix_features::fs::walkdir_sorted_new(&dir, Parallelism::Serial, usize::MAX, false)
         .follow_links(false)
         .into_iter()
         .filter_map(move |entry| {