Struct Dag

pub struct Dag {
    pub head_commit: CommitSet,
    pub main_branch_commit: CommitSet,
    pub branch_commits: CommitSet,
    /* private fields */
}

Interface to access the directed acyclic graph (DAG) representing Git’s commit graph. Based on the Eden SCM DAG.

Fields

head_commit: CommitSet

A set containing the commit which HEAD points to. If HEAD is unborn, this is an empty set.

main_branch_commit: CommitSet

A set containing the commit that the main branch currently points to.

branch_commits: CommitSet

A set containing all commits currently pointed to by local branches.

Implementations

impl Dag

pub fn try_clone(&self, repo: &Repo) -> Result<Self>

Reopen the DAG for the given repository.

pub fn open_and_sync( effects: &Effects, repo: &Repo, event_replayer: &EventReplayer, event_cursor: EventCursor, references_snapshot: &RepoReferencesSnapshot, ) -> Result<Self>

Initialize the DAG for the given repository, and update it with any newly-referenced commits.

pub fn open_without_syncing( effects: &Effects, repo: &Repo, event_replayer: &EventReplayer, event_cursor: EventCursor, references_snapshot: &RepoReferencesSnapshot, ) -> Result<Self>

Initialize a DAG for the given repository, without updating it with new commits that may have appeared.

If used improperly, commit lookups could fail at runtime. This function should only be used for opening the DAG when it’s known that no more live commits have appeared.

pub fn sync_from_oids( &mut self, effects: &Effects, repo: &Repo, master_heads: CommitSet, non_master_heads: CommitSet, ) -> Result<()>

Update the DAG with the given heads.

pub fn set_cursor( &self, effects: &Effects, repo: &Repo, event_replayer: &EventReplayer, event_cursor: EventCursor, ) -> Result<Self>

Create a new version of this DAG at the point in time represented by event_cursor.

pub fn clear_obsolete_commits(&self, repo: &Repo) -> Result<Self>

Create a new Dag with no obsolete commits.

pub fn sort(&self, commit_set: &CommitSet) -> Result<Vec<NonZeroOid>>

Wrapper around DAG method.

pub fn commit_set_to_vec( &self, commit_set: &CommitSet, ) -> Result<Vec<NonZeroOid>>

Eagerly convert a CommitSet into a Vec<NonZeroOid> by iterating over it, preserving order.

pub fn get_only_parent_oid(&self, oid: NonZeroOid) -> Result<NonZeroOid>

Get the parent OID for the given OID. Returns an error if the given OID does not have exactly 1 parent.

pub fn query(&self) -> &Dag

Conduct an arbitrary query against the DAG.

pub fn is_public_commit(&self, commit_oid: NonZeroOid) -> Result<bool>

Determine whether or not the given commit is a public commit (i.e. is an ancestor of the main branch).

pub fn query_is_ancestor( &self, ancestor: NonZeroOid, descendant: NonZeroOid, ) -> Result<bool>

Wrapper around DAG method.

pub fn set_is_empty(&self, commit_set: &CommitSet) -> Result<bool>

Wrapper around NameSet method.

pub fn set_contains<T: Into<CommitVertex> + Debug>( &self, commit_set: &CommitSet, oid: T, ) -> Result<bool>

Wrapper around NameSet method.

pub fn set_count(&self, commit_set: &CommitSet) -> Result<usize>

Wrapper around NameSet method.

pub fn set_first(&self, commit_set: &CommitSet) -> Result<Option<CommitVertex>>

Wrapper around NameSet method.

pub fn query_public_commits_slow(&self) -> Result<&CommitSet>

Return the set of commits which are public, as per the definition in is_public_commit. You should try to use is_public_commit instead, as it will be faster to compute.

pub fn query_visible_heads(&self) -> Result<&CommitSet>

Determine the set of commits which are considered to be “visible”. A commit is “visible” if it is not obsolete or has a non-obsolete descendant.

pub fn query_visible_commits_slow(&self) -> Result<&CommitSet>

Query the set of all visible commits, as per the definition in query_visible_heads. You should try to use query_visible_heads instead if possible, since it will be faster to compute.

pub fn filter_visible_commits(&self, commits: CommitSet) -> Result<CommitSet>

Keep only commits in the given set which are visible, as per the definition in query_visible_heads.

pub fn query_obsolete_commits(&self) -> CommitSet

Determine the set of obsolete commits. These commits have been rewritten or explicitly hidden by the user.

pub fn query_draft_commits(&self) -> Result<&CommitSet>

Determine the set of “draft” commits. The draft commits are all visible commits which aren’t public.

pub fn query_stack_commits(&self, commit_set: CommitSet) -> Result<CommitSet>

Determine the connected components among draft commits (commit “stacks”) that intersect with the provided set.

pub fn query_all(&self) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_parents(&self, commit_set: CommitSet) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_parent_names<T: Into<CommitVertex> + Debug>( &self, vertex: T, ) -> Result<Vec<CommitVertex>>

Wrapper around DAG method.

pub fn query_ancestors(&self, commit_set: CommitSet) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_first_ancestor_nth( &self, vertex: CommitVertex, n: u64, ) -> Result<Option<CommitVertex>>

Wrapper around DAG method.

pub fn query_children(&self, commit_set: CommitSet) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_descendants(&self, commit_set: CommitSet) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_roots(&self, commit_set: CommitSet) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_heads(&self, commit_set: CommitSet) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_heads_ancestors(&self, commit_set: CommitSet) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_only( &self, reachable: CommitSet, unreachable: CommitSet, ) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_range( &self, roots: CommitSet, heads: CommitSet, ) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_common_ancestors(&self, commit_set: CommitSet) -> Result<CommitSet>

Wrapper around DAG method.

pub fn query_gca_one( &self, commit_set: CommitSet, ) -> Result<Option<CommitVertex>>

Wrapper around DAG method.

pub fn query_gca_all(&self, commit_set: CommitSet) -> Result<CommitSet>

Wrapper around DAG method.

pub fn get_connected_components( &self, commit_set: &CommitSet, ) -> Result<Vec<CommitSet>>

Given a CommitSet, return a list of CommitSets, each representing a connected component of the set.

For example, if the DAG contains commits A-B-C-D-E-F and the given CommitSet contains B, C, E, this will return 2 CommitSets: 1 containing B, C and another containing only E

Trait Implementations

impl Debug for Dag

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

Formats the value using the given formatter.