Struct Clean 

#[non_exhaustive]
pub struct Clean {
    pub force: bool,
    pub dry_run: bool,
    pub directories: bool,
    pub ignored: CleanIgnored,
}

Options for GitApi::clean (git clean) — deletes untracked files from the working tree.

Force is a deliberate, explicit call, never a default. There is no Clean::new() state, nor any other setter, that arms deletion by itself — only the explicit force call does, the same “no bare bool, no implied default” pattern BranchDelete::force and WorktreeRemove::force use for their own destructive flag. Independently, GitApi::clean itself refuses to run at all — before spawning git — unless the spec picked either dry_run or force: this crate’s own guard, so the outcome never depends on whether the caller’s clean.requireForce git config happens to be (mis)set to false. When dry_run is set, force is ignored — dry-run always wins, so it is never possible to accidentally delete while asking for a preview.

#[non_exhaustive], so build it through Clean::new and the chained setters rather than a struct literal.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

force: bool

Actually delete rather than merely report (--force/-f). Ignored when dry_run is also set.

dry_run: bool

Report what would be deleted, without deleting anything (--dry-run/ -n). Takes priority over force.

directories: bool

Remove whole untracked directories, not just untracked files (-d).

ignored: CleanIgnored

How ignored files/directories are treated; see CleanIgnored.

Implementations

impl Clean

pub fn new() -> Self

A clean spec with neither dry_run nor force picked yet — passing this as-is to GitApi::clean is refused before spawning (see the type docs); chain one of the two setters before use.

pub fn force(self) -> Self

Actually delete (--force/-f) — the one, explicit way to arm deletion; see the type docs.

pub fn dry_run(self) -> Self

Report what would be deleted without deleting anything (--dry-run/-n).

pub fn directories(self) -> Self

Remove whole untracked directories too (-d).

pub fn include_ignored(self) -> Self

Also remove ignored files/directories (-x), in addition to ordinary untracked ones.

pub fn only_ignored(self) -> Self

Remove only ignored files/directories (-X).

Trait Implementations

impl Clone for Clean

fn clone(&self) -> Clean

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Clean

impl Debug for Clean

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

Formats the value using the given formatter.

impl Default for Clean

fn default() -> Clean

Returns the “default value” for a type.

impl Eq for Clean

impl PartialEq for Clean

fn eq(&self, other: &Clean) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Clean