Struct git_commitgraph::graph::Graph

pub struct Graph { /* private fields */ }

A complete commit graph.

The data in the commit graph may come from a monolithic objects/info/commit-graph file, or it may come from one or more objects/info/commit-graphs/graph-*.graph files. These files are generated via git commit-graph write ... commands.

Implementations

impl Graph

Access

pub fn commit_at(&self, pos: Position) -> Commit<'_>

Returns the commit at the given position pos.

Panics

If pos is greater or equal to num_commits().

pub fn commit_by_id(&self, id: impl AsRef<oid>) -> Option<Commit<'_>>

Returns the commit matching the given id.

pub fn id_at(&self, pos: Position) -> &oid

Returns the hash at the given position pos.

Panics

If pos is greater or equal to num_commits().

pub fn iter_commits(&self) -> impl Iterator<Item = Commit<'_>>

Iterate over commits in unsorted order.

pub fn iter_ids(&self) -> impl Iterator<Item = &oid>

Iterate over commit IDs in unsorted order.

pub fn lookup(&self, id: impl AsRef<oid>) -> Option<Position>

Translate the given id to its position in the file.

pub fn num_commits(&self) -> u32

Returns the number of commits stored in this file.

impl Graph

Instantiate a Graph from various sources.

pub fn at(path: impl AsRef<Path>) -> Result<Self, Error>

Instantiate a commit graph from path which may be a directory containing graph files or the graph file itself.

pub fn from_commit_graphs_dir(path: impl AsRef<Path>) -> Result<Self, Error>

Instantiate a commit graph from the directory containing all of its files.

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, Error>

Instantiate a commit graph from a .git/objects/info/commit-graph or .git/objects/info/commit-graphs/graph-*.graph file.

pub fn from_info_dir(info_dir: impl AsRef<Path>) -> Result<Self, Error>

Instantiate a commit graph from an .git/objects/info directory.

pub fn new(files: Vec<File>) -> Result<Self, Error>

Create a new commit graph from a list of files.

impl Graph

pub fn verify_integrity<E>(
    &self,
    processor: impl FnMut(&Commit<'_>) -> Result<(), E>
) -> Result<Outcome, Error<E>> where
    E: Error + 'static, 

Traverse all commits in the graph and call processor(&commit) -> Result<(), E> on it while verifying checksums.

When processor returns an error, the entire verification is stopped and the error returned.

Trait Implementations

impl TryFrom<&'_ Path> for Graph

type Error = Error

The type returned in the event of a conversion error.

fn try_from(path: &Path) -> Result<Self, Self::Error>

Performs the conversion.