feat(api)!: remove depth from DataTree::dir

Author: KSXGitHub

src/app/sub.rs

@@ -101,7 +101,6 @@ where
                 OsStringDisplay::os_string_from("(total)"),
                 Size::default(),
                 children,
-                max_depth.get(),
             )
         };
 

src/data_tree/constructors.rs

@@ -3,9 +3,8 @@ use crate::size;
 
 impl<Name, Size: size::Size> DataTree<Name, Size> {
     /// Create a tree representation of a directory.
-    pub fn dir(name: Name, inode_size: Size, children: Vec<Self>, depth: u64) -> Self {
+    pub fn dir(name: Name, inode_size: Size, children: Vec<Self>) -> Self {
         let size = inode_size + children.iter().map(DataTree::size).sum();
-        let children = if depth > 0 { children } else { Vec::new() };
         DataTree {
             name,
             size,
@@ -27,6 +26,11 @@ impl<Name, Size: size::Size> DataTree<Name, Size> {
     where
         Size: Copy,
     {
-        move |name, children| DataTree::dir(name, inode_size, children, 1)
+        move |name, children| DataTree::dir(name, inode_size, children)
+    }
+
+    /// Remove the children. Free memory usage.
+    pub(crate) fn drop_children(&mut self) {
+        self.children = Vec::new();
     }
 }

src/data_tree/retain/test.rs

@@ -7,7 +7,7 @@ type SampleData = Bytes;
 type SampleTree = DataTree<SampleName, SampleData>;
 
 fn dir<const INODE_SIZE: u64>(name: &'static str, children: Vec<SampleTree>) -> SampleTree {
-    SampleTree::dir(name.to_string(), INODE_SIZE.into(), children, 10)
+    SampleTree::dir(name.to_string(), INODE_SIZE.into(), children)
 }
 
 fn file(name: &'static str, size: u64) -> SampleTree {
@@ -23,7 +23,6 @@ fn culled_dir<const INODE_SIZE: u64>(
         name.to_string(),
         (INODE_SIZE + culled_size).into(),
         children,
-        10,
     )
 }
 

src/tree_builder.rs

@@ -59,8 +59,13 @@ where
                 max_depth,
             })
             .map(Self::from)
-            .collect();
+            .collect(); // TODO: this collect can be called into different types depending on whether `max_depth` is 0
 
-        DataTree::dir(name, size, children, max_depth)
+        let mut tree = DataTree::dir(name, size, children);
+        if max_depth == 0 {
+            // TODO: replace this with a more memory efficient method that doesn't require constructing `children` in the first place
+            tree.drop_children();
+        }
+        tree
     }
 }

tests/json.rs

@@ -30,7 +30,7 @@ type SampleTree = DataTree<SampleName, SampleData>;
 
 fn sample_tree() -> SampleTree {
     let dir = |name: &'static str, children: Vec<SampleTree>| {
-        SampleTree::dir(name.to_string(), 1024.into(), children, 10)
+        SampleTree::dir(name.to_string(), 1024.into(), children)
     };
     let file =
         |name: &'static str, size: u64| SampleTree::file(name.to_string(), Bytes::from(size));

tests/usual_cli.rs

@@ -623,7 +623,6 @@ fn multiple_names() {
                 OsStringDisplay::os_string_from("(total)"),
                 0.into(),
                 children.collect(),
-                10,
             )
         })
         .into_par_sorted(|left, right| left.size().cmp(&right.size()).reverse());

tests/visualizer.rs

@@ -403,7 +403,7 @@ fn nested_tree<Size: size::Size>(
 ) -> DataTree<&'static str, Size> {
     if let Some((head, tail)) = dir_names.split_first() {
         let child = nested_tree(tail, size_per_dir, file_name, file_size);
-        DataTree::dir(*head, size_per_dir, vec![child], 10)
+        DataTree::dir(*head, size_per_dir, vec![child])
     } else {
         DataTree::file(file_name, file_size)
     }
@@ -649,7 +649,7 @@ fn empty_dir<Size>(inode_size: Size) -> DataTree<&'static str, Size>
 where
     Size: size::Size + Ord + From<u64> + Send,
 {
-    DataTree::dir("empty directory", inode_size, Vec::new(), 10).into_par_sorted(order_tree)
+    DataTree::dir("empty directory", inode_size, Vec::new()).into_par_sorted(order_tree)
 }
 
 test_case! {