Struct RepoLayout 

pub struct RepoLayout { /* private fields */ }

Resolved repository layout: worktree root plus the two state directories (see the module docs for the classification table).

Cheap to clone; construction never touches the filesystem.

Implementations

impl RepoLayout

pub fn single(worktree_root: impl Into<PathBuf>) -> Self

Layout of a classic single-worktree repository rooted at worktree_root: common dir and worktree state dir are both <worktree_root>/.mkit.

pub fn worktree_root(&self) -> &Path

The working-tree root (directory whose files are under version control).

pub fn common_dir(&self) -> &Path

Shared state directory. Everything in it is common to all working trees of the repository.

pub fn worktree_state_dir(&self) -> &Path

Per-worktree state directory. Everything in it belongs to this working tree only.

pub fn is_single(&self) -> bool

true when common dir and worktree state dir coincide (the classic single-worktree layout).

pub fn linked( worktree_root: impl Into<PathBuf>, worktree_state_dir: impl Into<PathBuf>, common_dir: impl Into<PathBuf>, ) -> Self

Layout of a linked working tree (#493 Phase 1): working files at worktree_root, per-tree state in worktree_state_dir (a worktrees/<id> dir under the main repository’s common dir), shared state in common_dir.

Pure construction — no filesystem access, no validation beyond types. Production code obtains linked layouts via discover, which validates the on-disk pointers; this constructor is the seam discover and worktree add build on.

pub fn worktrees_dir(&self) -> PathBuf

worktrees/ — the common-dir directory holding every linked tree’s per-tree state dir.

pub fn worktree_state_dir_for(&self, id: &str) -> PathBuf

The per-tree state dir a linked worktree with id would use: worktrees/<id> under the common dir. The caller must have validated id via validate_worktree_id.

pub fn objects_dir(&self) -> PathBuf

objects/ — the content-addressed object store.

pub fn format_file(&self) -> PathBuf

format — the object-addressing format marker.

pub fn refs_dir(&self) -> PathBuf

refs/ — the ref tree root.

pub fn heads_dir(&self) -> PathBuf

refs/heads/ — branch refs.

pub fn tags_dir(&self) -> PathBuf

refs/tags/ — tag refs.

pub fn remotes_dir(&self) -> PathBuf

refs/remotes/ — remote-tracking refs.

pub fn shallow_file(&self) -> PathBuf

shallow — the shallow-clone boundary. Shared: it constrains the one object graph every worktree reads.

pub fn config_file(&self) -> PathBuf

config — the repository config file.

pub fn keys_dir(&self) -> PathBuf

keys/ — repository-local signing keys.

pub fn history_dir(&self) -> PathBuf

history/ — the append-only commit-history MMR.

pub fn recovery_log_file(&self) -> PathBuf

recovery-log — the append-only superseded-commit log.

pub fn attestations_dir(&self) -> PathBuf

attestations/ — the DSSE attestation store.

pub fn applied_packs_dir(&self) -> PathBuf

applied-packs/ — per-remote applied-pack records. A redownload-avoidance cache; never a gc root source, always safe to delete.

pub fn git_state_dir(&self) -> PathBuf

git/ — git-bridge per-remote state.

pub fn sparse_cache_dir(&self) -> PathBuf

sparse/ — the verifiable sparse-checkout bitmap cache (keyed by tree hash, so shared).

pub fn pack_shards_dir(&self) -> PathBuf

pack-shards/ — default output directory for pack shards.

pub fn head_file(&self) -> PathBuf

HEAD — this worktree’s checked-out branch or detached commit.

pub fn index_file(&self) -> PathBuf

index — this worktree’s staging index.

pub fn orig_head_file(&self) -> PathBuf

ORIG_HEAD — pre-operation HEAD snapshot.

pub fn merge_head_file(&self) -> PathBuf

MERGE_HEAD — in-progress merge counterpart commit.

pub fn merge_msg_file(&self) -> PathBuf

MERGE_MSG — in-progress merge message.

pub fn cherry_pick_head_file(&self) -> PathBuf

CHERRY_PICK_HEAD — in-progress cherry-pick source commit.

pub fn cherry_pick_msg_file(&self) -> PathBuf

CHERRY_PICK_MSG — in-progress cherry-pick message.

pub fn revert_head_file(&self) -> PathBuf

REVERT_HEAD — in-progress revert source commit.

pub fn revert_msg_file(&self) -> PathBuf

REVERT_MSG — in-progress revert message.

pub fn conflicts_file(&self) -> PathBuf

mkit-conflicts — conflict sidecar for the in-progress op.

pub fn result_tree_file(&self) -> PathBuf

MKIT_OP_RESULT — full result tree of the in-progress op.

pub fn rebase_dir(&self) -> PathBuf

rebase-apply/ — in-progress rebase state.

pub fn bisect_file(&self) -> PathBuf

bisect — in-progress bisect state.

pub fn stash_file(&self) -> PathBuf

stash — this worktree’s stash manifest (tree-local by #493).

pub fn sparse_checkout_file(&self) -> PathBuf

sparse-checkout — this worktree’s sparse filter spec.

Trait Implementations

impl Clone for RepoLayout

fn clone(&self) -> RepoLayout

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RepoLayout

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for RepoLayout

impl PartialEq for RepoLayout

fn eq(&self, other: &RepoLayout) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RepoLayout