Struct Deleter 

pub struct Deleter { /* private fields */ }

Removes what a Plan says to remove, and nothing else.

Implementations

impl Deleter

pub fn new() -> Self

A deleter with the default pool.

pub fn threads(self, threads: usize) -> Self

How many threads to remove with. Defaults to the machine’s parallelism times [OVERSUBSCRIPTION], bounded by [MAX_THREADS] and by the number of targets.

pub fn watching(self, sink: impl Fn(&Step) + Send + Sync + 'static) -> Self

Reports the removal as it happens, rather than only in the Removal at the end.

The batch CLI has no use for this — it prints one report when the removal is over — but a live view does, twice over. Step::Finished is what drops a row: a row for a directory that is already gone is one a reader can still put a cursor on, and one they can watch a second delete keystroke land on. Step::Freeing is what lets that row empty first, on the bytes actually leaving the disk rather than on a timer — the difference between showing what is happening and animating over the fact that it already happened.

Called from the pool, so sink is Send + Sync and may be called from several threads at once and in any order. A Finished sees exactly what Removal::removed will contain — same condition, same values — because both come from [Sweep::reported], and a Freeing is the same running total read earlier.

pub fn remove(&self, plan: &Plan) -> Removal

Executes the plan.

One target’s failure costs that target and nothing else: everything is collected and reported, and the caller turns a non-empty Removal::failures into a non-zero exit.

Trait Implementations

impl Clone for Deleter

fn clone(&self) -> Deleter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Deleter

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

Hand-written because a closure has no Debug, and the only interesting thing about one here is whether anybody is listening.

impl Default for Deleter

fn default() -> Deleter

Returns the “default value” for a type.