Struct PrivateIndexFacts 

pub struct PrivateIndexFacts<F: RepositoryFacts> { /* private fields */ }

What: Rule facts from the wrapped real repository and candidate reads from a private index. Why: The private index changes from one replay to the next, so the facts keep it as a replaceable value.

In TS you’d write (pseudocode):

type CommitFacts = { rules: RepositoryFacts; privateIndex: { indexPath: string; objectDirectory: string } };

Implementations

impl<F: RepositoryFacts> PrivateIndexFacts<F>

pub fn new(inner: F, index: &Path, object_directory: &Path) -> Self

What: Wrap rule facts with the private index and the object store the candidates are read from. Why: The candidate prediction copies the named index, so reading never changes the transaction’s index.

In TS you’d write (pseudocode):

createPrivateIndexFacts({ indexPath, objectDirectory });

pub fn use_index(&mut self, index: &Path, object_directory: &Path)

What: Read the candidates from another private index from now on. Why: A replay validates its own merged tree in replay-<n>/commit.index.

In TS you’d write (pseudocode):

facts = createPrivateIndexFacts({ indexPath: replayIndexPath, objectDirectory });

Trait Implementations

impl<F: RepositoryFacts> RepositoryFacts for PrivateIndexFacts<F>

fn location(&mut self) -> Result<RepositoryLocation, String>

Repository identity, worktree top level and the path below it; asked once.

fn index_vs_head(&mut self) -> Result<IndexVsHead, String>

Whether the index differs from HEAD.

fn worktree_dirty(&mut self, scope: DirtyScope) -> Result<bool, String>

Whether the worktree holds uncommitted state of the given scope.

fn sequencer_state(&mut self) -> Result<SequencerState, String>

Whether a merge, cherry-pick or revert awaits its concluding commit.

fn remote_guess_creates_branch( &mut self, target: &OsStr, ) -> Result<bool, String>

Whether git switch <target> or git checkout <target> would create a local branch from the one remote branch of that name.

fn candidates( &mut self, request: &CandidateRequest, ) -> Result<PreparedCandidates, CandidateError>

The candidates a content policy reads for this request, prepared on a private index; a failure carries the candidate layer’s cause.

fn asked_location(&self) -> Option<Result<RepositoryLocation, String>>

The location when it was already asked for, without asking.

fn transaction_context(&self) -> GitContext

Real Git, the child environment and the invocation’s global options, for transaction and recovery work.

fn known_common_dir(&mut self) -> Option<PathBuf>

The repository’s common Git directory when it is known without starting Git: from the location already asked, or from the file system. A provider that has neither answers nothing.

fn known_git_dir(&mut self) -> Option<PathBuf>

The invocation’s own Git directory (the worktree’s, which holds its work records and notices) when it is known without starting Git: from the location already asked, or from the file system. A provider that has neither answers nothing.