feat: add Status iterator.

TBD

Author: Byron

gix/src/lib.rs

@@ -133,8 +133,6 @@ pub use gix_ref as refs;
 pub use gix_refspec as refspec;
 pub use gix_revwalk as revwalk;
 pub use gix_sec as sec;
-#[cfg(feature = "status")]
-pub use gix_status as status;
 pub use gix_tempfile as tempfile;
 pub use gix_trace as trace;
 pub use gix_traverse as traverse;
@@ -317,6 +315,10 @@ pub mod init;
 /// Not to be confused with 'status'.
 pub mod state;
 
+///
+#[cfg(feature = "status")]
+pub mod status;
+
 ///
 pub mod shallow;
 

gix/src/status.rs

@@ -0,0 +1,21 @@
+use crate::Repository;
+pub use gix_status as plumbing;
+
+/// A structure to hold options configuring the status request, which can then be turned into an iterator.
+#[derive(Clone)]
+pub struct Platform<'repo> {
+    repo: &'repo Repository,
+}
+
+/// Status
+impl Repository {
+    /// Obtain a platform for configuring and traversing the git repository status.
+    ///
+    // TODO: assure that the index-to-worktree changes are implemented in such a way that the index
+    //       contains entries with UPTODATE flags set for each entry that didn't change.
+    //       Only then the dirwalk can run and do the right thing, which is avoid using filesystem access
+    //       to learn about the file type.
+    pub fn status(&self) -> Platform<'_> {
+        Platform { repo: self }
+    }
+}