Struct CleanupPlan 

pub struct CleanupPlan {
    pub action: CleanupAction,
    pub affected_classes: Vec<DataClass>,
    pub estimated_recovered_bytes: u64,
    pub requires_rebuild: bool,
    pub requires_confirmation: bool,
}

A cleanup plan: produced first, executed second (RFC-001 §14).

Fields

action: CleanupAction

affected_classes: Vec<DataClass>

estimated_recovered_bytes: u64

requires_rebuild: bool

requires_confirmation: bool

Implementations

impl CleanupPlan

pub fn for_action(action: CleanupAction, estimated_recovered_bytes: u64) -> Self

Build the plan for an action with an estimated byte impact.

pub fn assert_safe_for_ordinary_cleanup(&self) -> Result<(), OrbokError>

Safe cleanup must never include the persistent catalog. Executors call this before running anything that has not been explicitly confirmed as a destructive reset.

Trait Implementations

impl Clone for CleanupPlan

fn clone(&self) -> CleanupPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CleanupPlan

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CleanupPlan

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CleanupPlan

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.