Struct Plan 

pub struct Plan { /* private fields */ }

A resolved, checked list of directories to remove.

Building one performs every check in the safety model. The deleter re-derives nothing, so what Plan says is what happens.

Implementations

impl Plan

pub fn root(&self) -> &Path

The canonical scan root. Nothing outside it is ever touched.

pub fn targets(&self) -> &[PlanTarget]

The directories that will be removed.

pub fn kept(&self) -> &[Refused]

The directories that will not be, and why.

pub fn is_empty(&self) -> bool

Whether there is anything to do.

pub fn measured_bytes(&self) -> u64

The bytes the plan can put a number on. Read it beside Plan::unpriced: a default scan measures nothing, so a plan over a 40 GB tree can honestly report zero here.

pub fn unpriced(&self) -> usize

How many targets carry no size, because the scan pruned at them rather than walking them to produce a number it was about to discard.

Trait Implementations

impl Clone for Plan

fn clone(&self) -> Plan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Plan

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

Formats the value using the given formatter.