Struct Cleaner 

pub struct Cleaner;

Handles the cleanup of build directories from development projects.

The Cleaner struct provides methods for removing build directories (such as target/ for Rust projects and node_modules/ for Node.js projects) with parallel processing, progress reporting, and comprehensive error handling.

Implementations

impl Cleaner

pub const fn new() -> Self

Create a new cleaner instance.

Returns

A new Cleaner instance ready to perform cleanup operations.

Examples

let cleaner = Cleaner::new();

pub fn clean_projects( projects: Projects, keep_executables: bool, quiet: bool, removal_strategy: RemovalStrategy, ) -> CleanResult

Clean build directories from a collection of projects.

This method performs the main cleanup operation by:

1. Setting up a progress bar for user feedback (unless quiet)
2. Processing projects in parallel for efficiency
3. Collecting and reporting any errors that occur
4. Returning a CleanResult with detailed statistics

Arguments

• projects - A collection of projects to clean
• keep_executables - Whether to preserve compiled executables before cleaning
• quiet - When true, suppresses all human-readable output (progress bars, messages). Used by the --json flag so that only the final JSON is printed.
• removal_strategy - Whether to permanently delete or move to system trash

Panics

This method may panic if the progress bar template string is invalid, though this should not occur under normal circumstances as the template is hardcoded and valid.

Returns

A CleanResult containing success/failure counts, total freed bytes, and any error messages.

Performance

This method uses parallel processing to clean multiple projects simultaneously, which can significantly reduce cleanup time for large numbers of projects.

Error Handling

Individual project cleanup failures do not stop the overall process. All errors are collected and reported in the returned CleanResult, allowing the cleanup to proceed for projects that can be successfully processed.

pub fn print_summary(result: &CleanResult)

Print a human-readable cleanup summary to stdout.

This is called from main when --json is not active.

Trait Implementations

impl Default for Cleaner

fn default() -> Self

Create a default cleaner instance.

This implementation allows Cleaner::default() to be used as an alternative to Cleaner::new() for creating cleaner instances.

Returns

A new Cleaner instance with default settings.