Struct Repo 

pub struct Repo { /* private fields */ }

One git work tree, asked what it would clean.

Implementations

impl Repo

pub fn discover(from: &Path) -> Result<Self, RepoError>

Finds the work tree containing from and returns it.

The whole checkout, never a subdirectory of one, even when from is one. git clean scoped to a subdirectory cleans only that subtree while git reset --hard resets the entire work tree regardless, so a run rooted at a subdirectory would mean two different things by “here” in the same breath. Repo mode is the mode for cleaning a checkout, so it takes the checkout.

Errors

If git cannot be run, or from is not inside a work tree.

pub fn root(&self) -> &Path

The work tree’s root directory, as git names it.

pub fn enumerate(&self) -> Result<Enumeration, RepoError>

Asks git what it would remove.

Two invocations, because the point is to offer the two lists separately: -d for untracked and -d -X for ignored.

Errors

If git cannot be run, refuses, or prints something this cannot read.

pub fn reset(&self, reset: Reset) -> Result<(), RepoError>

Discards tracked changes.

Runs before any removal, because restoring a file the deleter is about to walk past is the one ordering here that has a consequence.

Errors

If git cannot be run or refuses — an unborn HEAD is the ordinary way to reach the second, and a run that could not reset has not done what it said it would.

Trait Implementations

impl Clone for Repo

fn clone(&self) -> Repo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Repo

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

Formats the value using the given formatter.