Sketch of the APIs involved in branch::apply().

Author: Byron

crates/but-workspace/src/lib.rs

@@ -1,4 +1,4 @@
-#![deny(missing_docs, rust_2018_idioms)]
+#![deny(missing_docs)]
 #![deny(clippy::indexing_slicing)]
 
 //! ### Terminology
@@ -55,6 +55,8 @@ pub use head::{head, merge_worktree_with_workspace};
 /// Ignore the name of this module; it's just a place to put code by now.
 pub mod branch;
 
+pub mod snapshot;
+
 mod changeset;
 
 mod commit;

crates/but-workspace/src/snapshot.rs

@@ -0,0 +1,27 @@
+//! The ability to create a Git representation of diverse 'state' that can be restored at a later time.
+
+///
+pub mod create_tree {
+
+    /// A way to determine what should be included in the snapshot when calling [create_tree()]()
+    pub struct StateSelect {}
+
+    /// Contains all state that the snapshot contains.
+    #[derive(Debug, Copy, Clone)]
+    pub struct Outcome {
+        /// The combined tree with all snapshot information.
+        pub tree: gix::ObjectId,
+    }
+
+    pub(super) mod function {
+        /// Create a tree that represents the snapshot for the given `state`, with the basis for everything
+        /// being the `head_tree_id` (i.e. the tree to which `HEAD` is ultimately pointing to).
+        ///
+        /// Note that objects will be written into the repository behind `head_tree_id` unless it's configured
+        /// to keep everything in memory.
+        pub fn create_tree(head_tree_id: gix::Id<'_>) -> ! {
+            todo!()
+        }
+    }
+}
+pub use create_tree::function::create_tree;