feat: a way for status to stop early.

That way, 'is_dirty()` scenarios can be done without wasting too much time.

Author: Byron

gix-status/src/index_as_worktree/function.rs

@@ -1,4 +1,4 @@
-use std::sync::atomic::{AtomicU64, AtomicUsize, Ordering};
+use std::sync::atomic::{AtomicBool, AtomicU64, AtomicUsize, Ordering};
 use std::{io, marker::PhantomData, path::Path};
 
 use bstr::BStr;
@@ -23,6 +23,8 @@ use crate::{
 /// Note that `index` is updated with the latest seen stat information from the worktree, and its timestamp is adjusted to
 /// the current time for which it will be considered fresh as long as it is included which depends on `pathspec`.
 ///
+/// `should_interrupt` can be used to stop all processing.
+///
 /// ### Note
 ///
 /// Technically, this function does more as this also provides additional information, like whether a file has conflicts,
@@ -43,6 +45,7 @@ pub fn index_as_worktree<'index, T, U, Find, E1, E2>(
     find: Find,
     progress: &mut dyn gix_features::progress::Progress,
     pathspec: impl Pathspec + Send + Clone,
+    should_interrupt: &AtomicBool,
     options: Options,
 ) -> Result<Outcome, Error>
 where
@@ -68,7 +71,7 @@ where
         .prefixed_entries_range(pathspec.common_prefix())
         .unwrap_or(0..index.entries().len());
     let (entries, path_backing) = index.entries_mut_and_pathbacking();
-    let num_entries = entries.len();
+    let mut num_entries = entries.len();
     let entries = &mut entries[range];
 
     let _span = gix_features::trace::detail!("gix_status::index_as_worktree", 
@@ -80,12 +83,13 @@ where
     let (skipped_by_pathspec, skipped_by_entry_flags, symlink_metadata_calls, entries_updated) = Default::default();
     let (worktree_bytes, worktree_reads, odb_bytes, odb_reads, racy_clean) = Default::default();
 
+    num_entries = entries.len();
     progress.init(entries.len().into(), gix_features::progress::count("files"));
     let count = progress.counter();
 
     in_parallel_if(
         || true, // TODO: heuristic: when is parallelization not worth it? Git says 500 items per thread, but to 20 threads, we can be more fine-grained though.
-        entries.chunks_mut(chunk_size),
+        gix_features::interrupt::Iter::new(entries.chunks_mut(chunk_size), should_interrupt),
         thread_limit,
         {
             let options = &options;
@@ -137,6 +141,8 @@ where
     )?;
 
     Ok(Outcome {
+        entries_to_process: num_entries,
+        entries_processed: count.load(Ordering::Relaxed),
         entries_skipped_by_common_prefix,
         entries_skipped_by_pathspec: skipped_by_pathspec.load(Ordering::Relaxed),
         entries_skipped_by_entry_flags: skipped_by_entry_flags.load(Ordering::Relaxed),

gix-status/src/index_as_worktree/types.rs

@@ -35,6 +35,10 @@ pub struct Options {
 /// Provide additional information collected during the runtime of [`index_as_worktree()`](crate::index_as_worktree()).
 #[derive(Clone, Debug, Default, Eq, PartialEq, Ord, PartialOrd)]
 pub struct Outcome {
+    /// The total amount of entries that is to be processed.
+    pub entries_to_process: usize,
+    /// The amount of entries we actually processed. If this isn't the entire set, the operation was interrupted.
+    pub entries_processed: usize,
     /// The amount of entries we didn't even traverse (and thus update with stat) due to a common prefix in pathspecs.
     /// This is similar to the current working directory.
     pub entries_skipped_by_common_prefix: usize,

gix-status/tests/status/index_as_worktree.rs

@@ -1,3 +1,4 @@
+use std::sync::atomic::AtomicBool;
 use std::sync::{
     atomic::{AtomicUsize, Ordering},
     Arc,
@@ -75,6 +76,7 @@ fn fixture_filtered_detailed(
         |_, _| Ok::<_, std::convert::Infallible>(gix_object::BlobRef { data: &[] }),
         &mut gix_features::progress::Discard,
         Pathspec(search),
+        &AtomicBool::default(),
         Options {
             fs: gix_fs::Capabilities::probe(&git_dir),
             stat: TEST_OPTIONS,
@@ -131,6 +133,8 @@ fn removed() {
     assert_eq!(
         out,
         Outcome {
+            entries_to_process: 4,
+            entries_processed: 4,
             symlink_metadata_calls: 4,
             ..Default::default()
         }
@@ -147,6 +151,8 @@ fn removed() {
     assert_eq!(
         out,
         Outcome {
+            entries_to_process: 2,
+            entries_processed: 2,
             entries_skipped_by_common_prefix: 2,
             symlink_metadata_calls: 2,
             ..Default::default()
@@ -159,6 +165,8 @@ fn subomdule_nochange() {
     assert_eq!(
         ignore_racyclean(submodule_fixture("no-change", &[])),
         Outcome {
+            entries_to_process: 2,
+            entries_processed: 2,
             entries_updated: 1,
             symlink_metadata_calls: 2,
             worktree_bytes: 46,
@@ -176,6 +184,8 @@ fn subomdule_deleted_dir() {
             &[(BStr::new(b"m1"), Some(Change::Removed), NO_CONFLICT)]
         )),
         Outcome {
+            entries_to_process: 2,
+            entries_processed: 2,
             entries_updated: 1,
             symlink_metadata_calls: 2,
             worktree_files_read: 1,
@@ -193,6 +203,8 @@ fn subomdule_typechange() {
             &[(BStr::new(b"m1"), Some(Change::Type), NO_CONFLICT)]
         )),
         Outcome {
+            entries_to_process: 2,
+            entries_processed: 2,
             entries_updated: 1,
             symlink_metadata_calls: 2,
             worktree_files_read: 1,
@@ -207,6 +219,8 @@ fn subomdule_empty_dir_no_change() {
     assert_eq!(
         ignore_racyclean(submodule_fixture("empty-dir-no-change", &[])),
         Outcome {
+            entries_to_process: 2,
+            entries_processed: 2,
             entries_updated: 1,
             symlink_metadata_calls: 2,
             worktree_files_read: 1,
@@ -225,6 +239,8 @@ fn subomdule_empty_dir_no_change_is_passed_to_submodule_handler() {
             true,
         )),
         Outcome {
+            entries_to_process: 2,
+            entries_processed: 2,
             entries_updated: 1,
             symlink_metadata_calls: 2,
             worktree_files_read: 1,
@@ -242,6 +258,8 @@ fn intent_to_add() {
             &[(BStr::new(b"content"), Some(Change::IntentToAdd), NO_CONFLICT)],
         ),
         Outcome {
+            entries_to_process: 1,
+            entries_processed: 1,
             symlink_metadata_calls: 1,
             ..Default::default()
         }
@@ -263,6 +281,8 @@ fn conflict() {
             )],
         ),
         Outcome {
+            entries_to_process: 3,
+            entries_processed: 3,
             symlink_metadata_calls: 1,
             worktree_files_read: 1,
             worktree_bytes: 51,
@@ -314,6 +334,8 @@ fn modified() {
             ],
         ),
         Outcome {
+            entries_to_process: 5,
+            entries_processed: 5,
             symlink_metadata_calls: 5,
             entries_updated: 1,
             worktree_files_read: 2,
@@ -379,6 +401,7 @@ fn racy_git() {
         |_, _| Err(std::io::Error::new(std::io::ErrorKind::Other, "no odb access expected")),
         &mut gix_features::progress::Discard,
         Pathspec::default(),
+        &AtomicBool::default(),
         Options {
             fs,
             stat: TEST_OPTIONS,
@@ -389,6 +412,8 @@ fn racy_git() {
     assert_eq!(
         out,
         Outcome {
+            entries_to_process: 1,
+            entries_processed: 1,
             symlink_metadata_calls: 1,
             ..Default::default()
         }
@@ -414,6 +439,7 @@ fn racy_git() {
         |_, _| Err(std::io::Error::new(std::io::ErrorKind::Other, "no odb access expected")),
         &mut gix_features::progress::Discard,
         Pathspec::default(),
+        &AtomicBool::default(),
         Options {
             fs,
             stat: TEST_OPTIONS,
@@ -424,6 +450,8 @@ fn racy_git() {
     assert_eq!(
         out,
         Outcome {
+            entries_to_process: 1,
+            entries_processed: 1,
             symlink_metadata_calls: 1,
             racy_clean: 1,
             worktree_bytes: 3,