fix: public access to the contained repository in wrapped types, like Id.

This makes these types easier to use as it's enough to pass a wrapped type
to perform more actions on the underlying repository.

Author: Byron

gix/src/commit.rs

@@ -173,7 +173,8 @@ pub mod describe {
     /// A support type to allow configuring a `git describe` operation
     pub struct Platform<'repo> {
         pub(crate) id: gix_hash::ObjectId,
-        pub(crate) repo: &'repo crate::Repository,
+        /// The owning repository.
+        pub repo: &'repo crate::Repository,
         pub(crate) select: SelectRef,
         pub(crate) first_parent: bool,
         pub(crate) id_as_fallback: bool,

gix/src/config/mod.rs

@@ -18,7 +18,8 @@ pub use tree::root::Tree;
 ///
 /// Note that these values won't update even if the underlying file(s) change.
 pub struct Snapshot<'repo> {
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
 }
 
 /// A platform to access configuration values and modify them in memory, while making them available when this platform is dropped
@@ -31,13 +32,15 @@ pub struct Snapshot<'repo> {
 // TODO: make it possible to load snapshots with reloading via .config() and write mutated snapshots back to disk which should be the way
 //       to affect all instances of a repo, probably via `config_mut()` and `config_mut_at()`.
 pub struct SnapshotMut<'repo> {
-    pub(crate) repo: Option<&'repo mut Repository>,
+    /// The owning repository.
+    pub repo: Option<&'repo mut Repository>,
     pub(crate) config: gix_config::File<'static>,
 }
 
 /// A utility structure created by [`SnapshotMut::commit_auto_rollback()`] that restores the previous configuration on drop.
 pub struct CommitAutoRollback<'repo> {
-    pub(crate) repo: Option<&'repo mut Repository>,
+    /// The owning repository.
+    pub repo: Option<&'repo mut Repository>,
     pub(crate) prev_config: crate::Config,
 }
 

gix/src/object/tree/iter.rs

@@ -5,8 +5,8 @@ use crate::Repository;
 pub struct EntryRef<'repo, 'a> {
     /// The actual entry ref we are wrapping.
     pub inner: gix_object::tree::EntryRef<'a>,
-
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
 }
 
 impl<'repo, 'a> EntryRef<'repo, 'a> {

gix/src/object/tree/mod.rs

@@ -10,7 +10,8 @@ use crate::{object::find, Id, ObjectDetached, Tree};
 pub struct Editor<'repo> {
     pub(crate) inner: gix_object::tree::Editor<'repo>,
     pub(crate) validate: gix_validate::path::component::Options,
-    pub(crate) repo: &'repo crate::Repository,
+    /// The owning repository.
+    pub repo: &'repo crate::Repository,
 }
 
 /// Initialization
@@ -197,7 +198,8 @@ impl std::fmt::Debug for Tree<'_> {
 #[derive(PartialEq, Debug, Clone)]
 pub struct Entry<'repo> {
     pub(crate) inner: gix_object::tree::Entry,
-    pub(crate) repo: &'repo crate::Repository,
+    /// The owning repository.
+    pub repo: &'repo crate::Repository,
 }
 
 mod entry {

gix/src/reference/iter.rs

@@ -8,7 +8,8 @@ use gix_ref::file::ReferenceExt;
 #[must_use = "Iterators should be obtained from this iterator platform"]
 pub struct Platform<'r> {
     pub(crate) platform: gix_ref::file::iter::Platform<'r>,
-    pub(crate) repo: &'r crate::Repository,
+    /// The owning repository.
+    pub repo: &'r crate::Repository,
 }
 
 /// An iterator over references, with or without filter.

gix/src/revision/mod.rs

@@ -28,5 +28,6 @@ pub struct Spec<'repo> {
     pub(crate) first_ref: Option<gix_ref::Reference>,
     /// The second name of a reference as seen while parsing a `RevSpec`, for completeness.
     pub(crate) second_ref: Option<gix_ref::Reference>,
-    pub(crate) repo: &'repo crate::Repository,
+    /// The owning repository.
+    pub repo: &'repo crate::Repository,
 }

gix/src/revision/walk.rs

@@ -152,7 +152,8 @@ impl<'repo> Info<'repo> {
 /// author or commit messages will be required of *all* commits traversed here, it should be better to avoid trying to load it
 /// by [turning commit-graph support off][Platform::use_commit_graph()]. This certainly is a micro-optimization though.
 pub struct Platform<'repo> {
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
     pub(crate) tips: Vec<ObjectId>,
     pub(crate) prune: Vec<ObjectId>,
     pub(crate) sorting: Sorting,
@@ -334,7 +335,8 @@ pub mod iter {
 pub(crate) mod iter_impl {
     /// The iterator returned by [`crate::revision::walk::Platform::all()`].
     pub struct Walk<'repo> {
-        pub(crate) repo: &'repo crate::Repository,
+        /// The owning repository.
+        pub repo: &'repo crate::Repository,
         pub(crate) inner: Box<dyn Iterator<Item = Result<gix_traverse::commit::Info, super::iter::Error>> + 'repo>,
     }
 

gix/src/submodule/mod.rs

@@ -23,7 +23,7 @@ pub use errors::*;
 
 /// A platform maintaining state needed to interact with submodules, created by [`Repository::submodules()].
 pub(crate) struct SharedState<'repo> {
-    pub(crate) repo: &'repo Repository,
+    pub repo: &'repo Repository,
     pub(crate) modules: ModulesSnapshot,
     is_active: RefCell<Option<IsActiveState>>,
     index: RefCell<Option<IndexPersistedOrInMemory>>,

gix/src/types.rs

@@ -19,15 +19,17 @@ pub struct Worktree<'repo> {
 pub struct Head<'repo> {
     /// One of various possible states for the HEAD reference
     pub kind: head::Kind,
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
 }
 
 /// An [`ObjectId`] with access to a repository.
 #[derive(Clone, Copy)]
 pub struct Id<'r> {
     /// The actual object id
     pub(crate) inner: ObjectId,
-    pub(crate) repo: &'r Repository,
+    /// The owning repository.
+    pub repo: &'r Repository,
 }
 
 /// A decoded object with a reference to its owning repository.
@@ -39,7 +41,8 @@ pub struct Object<'repo> {
     pub kind: gix_object::Kind,
     /// The fully decoded object data
     pub data: Vec<u8>,
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
 }
 
 impl Drop for Object<'_> {
@@ -55,7 +58,8 @@ pub struct Blob<'repo> {
     pub id: ObjectId,
     /// The blob's data.
     pub data: Vec<u8>,
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
 }
 
 impl Drop for Blob<'_> {
@@ -71,7 +75,8 @@ pub struct Tree<'repo> {
     pub id: ObjectId,
     /// The fully decoded tree data
     pub data: Vec<u8>,
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
 }
 
 impl Drop for Tree<'_> {
@@ -87,7 +92,8 @@ pub struct Tag<'repo> {
     pub id: ObjectId,
     /// The fully decoded tag data
     pub data: Vec<u8>,
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
 }
 
 impl Drop for Tag<'_> {
@@ -103,7 +109,8 @@ pub struct Commit<'repo> {
     pub id: ObjectId,
     /// The fully decoded commit data
     pub data: Vec<u8>,
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
 }
 
 impl Drop for Commit<'_> {
@@ -132,7 +139,8 @@ pub struct ObjectDetached {
 pub struct Reference<'r> {
     /// The actual reference data
     pub inner: gix_ref::Reference,
-    pub(crate) repo: &'r Repository,
+    /// The owning repository.
+    pub repo: &'r Repository,
 }
 
 /// A thread-local handle to interact with a repository from a single thread.
@@ -219,7 +227,8 @@ pub struct Remote<'repo> {
     // pub(crate) prune: bool,
     // /// Delete tags that don't exist on the remote anymore, equivalent to pruning the refspec `refs/tags/*:refs/tags/*`.
     // pub(crate) prune_tags: bool,
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
 }
 
 /// A utility to make matching against pathspecs simple.
@@ -231,7 +240,8 @@ pub struct Remote<'repo> {
 #[derive(Clone)]
 #[cfg(feature = "attributes")]
 pub struct Pathspec<'repo> {
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
     /// The cache to power attribute access. It's only initialized if we have a pattern with attributes.
     pub(crate) stack: Option<gix_worktree::Stack>,
     /// The prepared search to use for checking matches.
@@ -261,6 +271,7 @@ pub struct Submodule<'repo> {
 /// A utility to access `.gitattributes` and `.gitignore` information efficiently.
 #[cfg(any(feature = "attributes", feature = "excludes"))]
 pub struct AttributeStack<'repo> {
-    pub(crate) repo: &'repo Repository,
+    /// The owning repository.
+    pub repo: &'repo Repository,
     pub(crate) inner: gix_worktree::Stack,
 }