cargo-reclaim 0.2.1

Safe Cargo cleanup for target directories, stale artifacts, and Cargo home caches
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use crate::persistence::PlanId;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ApplyReport {
    pub plan_id: PlanId,
    pub dry_run: bool,
    pub entries: Vec<ApplyEntryResult>,
    pub totals: ApplyTotals,
}

#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct ApplyTotals {
    pub entry_count: usize,
    pub delete_candidate_count: usize,
    pub would_delete_count: usize,
    pub skipped_count: usize,
    pub stale_skip_count: usize,
    pub applied_count: usize,
    pub failed_count: usize,
    pub would_delete_bytes: u64,
    pub applied_bytes: u64,
}

impl ApplyReport {
    pub(super) fn new(plan_id: PlanId, entries: Vec<ApplyEntryResult>) -> Self {
        Self {
            plan_id,
            dry_run: true,
            totals: ApplyTotals::from_entries(&entries),
            entries,
        }
    }

    pub(super) fn executed(plan_id: PlanId, entries: Vec<ApplyEntryResult>) -> Self {
        Self {
            plan_id,
            dry_run: false,
            totals: ApplyTotals::from_entries(&entries),
            entries,
        }
    }
}

impl ApplyTotals {
    fn from_entries(entries: &[ApplyEntryResult]) -> Self {
        let mut totals = Self {
            entry_count: entries.len(),
            ..Self::default()
        };

        for entry in entries {
            if entry.planned_action == "delete" {
                totals.delete_candidate_count += 1;
            }

            match entry.status {
                ApplyEntryStatus::WouldDelete => {
                    totals.would_delete_count += 1;
                    totals.would_delete_bytes =
                        totals.would_delete_bytes.saturating_add(entry.size_bytes);
                }
                ApplyEntryStatus::Deleted => {
                    totals.applied_count += 1;
                    totals.applied_bytes = totals
                        .applied_bytes
                        .saturating_add(entry.deleted_bytes.unwrap_or(entry.size_bytes));
                }
                ApplyEntryStatus::NotPlannedForDeletion => totals.skipped_count += 1,
                ApplyEntryStatus::SkipStalePlan => {
                    totals.skipped_count += 1;
                    totals.stale_skip_count += 1;
                }
                ApplyEntryStatus::DeleteFailed => totals.failed_count += 1,
            }
        }

        totals
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ApplyEntryResult {
    pub path: String,
    pub planned_action: String,
    pub status: ApplyEntryStatus,
    pub reason: String,
    pub size_bytes: u64,
    pub deleted_bytes: Option<u64>,
}

impl ApplyEntryResult {
    pub(super) fn new(
        path: String,
        planned_action: String,
        status: ApplyEntryStatus,
        size_bytes: u64,
        reason: impl Into<String>,
    ) -> Self {
        Self {
            path,
            planned_action,
            status,
            reason: reason.into(),
            size_bytes,
            deleted_bytes: None,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ApplyEntryStatus {
    WouldDelete,
    Deleted,
    NotPlannedForDeletion,
    SkipStalePlan,
    DeleteFailed,
}