Struct HistoryIndex 

pub struct HistoryIndex { /* private fields */ }

Available on crate feature vcs-git only.

The result of one history walk: per-file Stats keyed by repository-relative path, plus walk-level metadata.

Implementations

impl HistoryIndex

pub fn new( files: HashMap<PathBuf, Stats>, workdir: Option<PathBuf>, truncated_shallow_clone: bool, ) -> Self

Construct an index from its parts. Used by backends.

pub fn with_bus_factor(self, bus_factor: Option<BusFactor>) -> Self

Attach the directory- / repo-level bus-factor aggregate (issue #332). A builder rather than a new parameter so the established constructor signature stays source-compatible for downstream backends; the aggregate is computed only when a front end opts in via Options::compute_bus_factor.

pub fn bus_factor(&self) -> Option<&BusFactor>

The bus-factor aggregate, if it was computed for this walk.

pub fn vcs_aggregate(&self) -> Option<VcsAggregate>

The walk’s whole-repo aggregates wrapped in the top-level bus_factor::VcsAggregate object the front ends emit, or None when no aggregate was computed. The single projection shared by the CLI / web / Python surfaces so the vcs_aggregate shape cannot drift between them.

pub fn get(&self, repo_relative: &Path) -> Option<&Stats>

Look up stats by repository-relative path.

pub fn get_for_path(&self, absolute: &Path) -> Option<&Stats>

Look up stats for an absolute filesystem path by stripping the working-tree prefix. Returns None for paths outside the work tree or when the repository is bare (no work tree).

absolute must be in the same canonical form as the workdir the index was built with (the gix-backed builder stores an already-canonical workdir, and the CLI canonicalizes its inputs to match). A non-canonical caller — a symlinked or ..-laden path that does not share the stored prefix — silently yields None rather than an error, so a future backend or external caller passing raw paths must canonicalize first.

pub fn iter(&self) -> impl Iterator<Item = (&PathBuf, &Stats)>

Iterate (repo-relative path, stats) pairs.

pub fn len(&self) -> usize

Number of files in the index.

pub fn is_empty(&self) -> bool

Whether the index is empty (empty repo, or no tracked text files at the target ref).

pub fn truncated_shallow_clone(&self) -> bool

true when the repository is a shallow clone and history was therefore truncated; the front end surfaces this as a warning.

pub fn workdir(&self) -> Option<&Path>

The repository working-tree root, if any (None for bare repos).

pub fn into_files(self) -> HashMap<PathBuf, Stats>

Consume the index, yielding its per-file map.

Trait Implementations

impl Clone for HistoryIndex

fn clone(&self) -> HistoryIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HistoryIndex

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

Formats the value using the given formatter.

impl Default for HistoryIndex

fn default() -> HistoryIndex

Returns the “default value” for a type.