Struct GitStatusCache 

pub struct GitStatusCache { /* private fields */ }

Git status cache for efficient lookups.

Implementations

impl GitStatusCache

pub fn new() -> Self

Create a new empty cache.

pub fn initialize(&mut self, start_path: &Path) -> bool

Initialize the cache by discovering and scanning the git repository.

start_path is the directory we are scanning (the subtree root). The git status query is restricted to that subtree via a pathspec so that only relevant entries are loaded, keeping memory usage proportional to the scanned directory rather than the whole repository.

Returns true if a worktree was found, even if querying its status failed. Inspect initialization_error for failures.

pub fn get_status(&self, path: &Path) -> Option<GitStatus>

Get the git status for a path.

Falls back to canonicalizing the path so callers can pass a non-canonical form (a /var path on macOS, say, where the repository workdir resolves to /private/var). That fallback costs a syscall, so bulk callers should use get_status_canonical.

pub fn get_status_canonical(&self, path: &Path) -> Option<GitStatus>

Look up a path that is already known to be canonical.

Unlike get_status this never touches the filesystem, which matters when annotating a whole tree: clean files miss the map, and the canonicalizing fallback would then cost one syscall per node across the entire scan.

pub fn is_in_repo(&self, path: &Path) -> bool

Check if the path is within a git repository.

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

Get the repository root path.

pub fn initialization_error(&self) -> Option<&str>

Failure from the last initialization; absence of a repository is not an error.

pub fn len(&self) -> usize

Get the number of explicit cached statuses. An ignored directory may represent many descendants; clean tracked exceptions are not counted.

pub fn is_empty(&self) -> bool

Check if the cache is empty.

Trait Implementations

impl Debug for GitStatusCache

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

Formats the value using the given formatter.

impl Default for GitStatusCache

fn default() -> Self

Returns the “default value” for a type.