Struct WorkTree 

pub struct WorkTree { /* private fields */ }

One git work tree, with the set of paths its index tracks.

Implementations

impl WorkTree

pub fn open(root: &Path) -> Result<Self, GitError>

Reads the index of the work tree rooted at root.

Errors

If git cannot be run at all, or refuses to list the index.

pub fn root(&self) -> &Path

The work tree’s root directory.

pub fn tracked(&self) -> usize

How many paths the index tracks.

pub fn holds_tracked_path(&self, dir: &Path) -> bool

Whether anything tracked lives at or below dir.

Answers true for a path this work tree cannot express, because every caller is asking in order to decide whether deleting dir is safe, and “I could not tell” has to read as “do not touch it”.

Trait Implementations

impl Debug for WorkTree

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

Formats the value using the given formatter.