Struct Rule 

pub struct Rule {
    pub name: Arc<str>,
    /* private fields */
}

A cleanup rule: what identifies a project, and what may be reclaimed from it.

Fields

name: Arc<str>

Implementations

impl Rule

pub fn remove( name: &str, markers: &[&str], targets: &[&str], ) -> Result<Self, RuleError>

A rule that reclaims targets from any directory containing all of markers.

pub fn remove_targets( name: &str, markers: &[&str], targets: Vec<Target>, ) -> Result<Self, RuleError>

A rule that reclaims targets, for targets that are not plain directories.

pub fn remove_self(name: &str, markers: &[&str]) -> Result<Self, RuleError>

A rule that reclaims the matched directory itself.

pub fn prune_stale_worktrees( name: &str, markers: &[&str], ) -> Result<Self, RuleError>

A rule that prunes the records of git worktrees whose checkout is gone.

pub fn run( name: &str, markers: &[&str], command: &str, ) -> Result<Self, RuleError>

A rule that runs command in the matched directory.

pub fn action(&self) -> &CleanAction

pub fn matches(&self, entries: &[FileInfo]) -> bool

Whether a directory holding entries is a project this rule applies to.

Every marker must be present. Alternatives are expressed as globs (build.gradle*) or as separate rules, so there is no any-of mode to configure.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.