Struct DocumentMaintenanceStatus 

pub struct DocumentMaintenanceStatus { /* private fields */ }

Snapshot of maintenance-oriented document state such as fragmentation and compaction advice.

Implementations

impl DocumentMaintenanceStatus

pub const fn new( backing: DocumentBacking, fragmentation: Option<FragmentationStats>, compaction: Option<CompactionRecommendation>, ) -> Self

Creates a maintenance status snapshot.

pub const fn backing(self) -> DocumentBacking

Returns the current document backing mode.

pub const fn has_piece_table(self) -> bool

Returns true when the document currently uses a piece table.

pub const fn fragmentation_stats(self) -> Option<FragmentationStats>

Returns fragmentation metrics when they are meaningful for the current backing.

pub const fn has_fragmentation_stats(self) -> bool

Returns true when fragmentation metrics are available.

pub const fn compaction_recommendation(self) -> Option<CompactionRecommendation>

Returns the current compaction recommendation, if any.

pub const fn is_compaction_recommended(self) -> bool

Returns true when the current maintenance policy recommends compaction.

pub fn compaction_urgency(self) -> Option<CompactionUrgency>

Returns the current compaction urgency, if a recommendation exists.

pub fn recommended_action(self) -> MaintenanceAction

Returns the high-level maintenance action implied by this snapshot.

pub fn should_run_idle_compaction(self) -> bool

Returns true when idle compaction is currently recommended.

pub fn should_wait_for_explicit_compaction(self) -> bool

Returns true when heavier maintenance should be deferred to an explicit operator/save boundary.

Trait Implementations

impl Clone for DocumentMaintenanceStatus

fn clone(&self) -> DocumentMaintenanceStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentMaintenanceStatus

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

Formats the value using the given formatter.

impl PartialEq for DocumentMaintenanceStatus

fn eq(&self, other: &DocumentMaintenanceStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DocumentMaintenanceStatus

impl StructuralPartialEq for DocumentMaintenanceStatus