Struct gitdag::GitDag

pub struct GitDag { /* fields omitted */ }

GitDag maintains segmented changelog as an index on the Git commit graph.

This struct provides a "read-only" view for the commit graph. To read other parts of the git repo, or make changes to the Git commit graph, use a separate git2::Repository object.

The dag part is append-only. It might include vertexes no longer referred by the git repo. Use ancestors(git_heads()) to get commits referred by the git repo, and use & to filter them.

Implementations

impl GitDag

pub fn open(git_dir: &Path, dag_dir: &Path, main_branch: &str) -> Result<Self>

open a Git repo at git_dir. Build index at dag_dir, with specified main_branch.

pub fn open_git_repo(
    git_repo: &Repository,
    dag_dir: &Path,
    main_branch: &str
) -> Result<Self>

For an git repo, build index at dag_dir with specified main_branch.

pub fn git_references(&self) -> &BTreeMap<String, Vertex>

Get "snapshotted" references.

pub fn git_heads(&self) -> Set

Get "snapshotted" heads.

Trait Implementations

impl Deref for GitDag

type Target = Dag

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.