Struct PassBudget 

pub struct PassBudget { /* private fields */ }

The work one garbage-collection pass is allowed to do.

One unit is one object the pass reads or decides on a candidate’s behalf:

• one enumerated candidate key, decided — the original meaning of max_objects;
• one manifest opened by the content reference scan;
• one page of revision rows read out of an opened manifest;
• one retained WAL segment fetched by the scan.

Prefix listing is the one thing not metered: it is how a family finds candidates at all, and the cursor is what resumes it. Everything else a pass touches is charged, so no pass can do work proportional to the namespace while asking for a small budget.

The rule is deliberately coarse — it is a bound, not a cost model. A page of rows costs more than a manifest header and both count as one. What matters is that every store round trip inside the pass has a charge attached to it, and that running out stops the pass instead of letting it finish “just this one thing” unboundedly.

Implementations

impl PassBudget

pub fn new(max_objects: Option<u64>) -> Self

Meters a pass at max_objects units, or at nothing when absent.

pub fn exhausted(&self) -> bool

True once nothing further may be charged: the caller stops where it stands. The sweep returns its cursor; the content reference scan gives up on collecting and the pass defers that reclamation.

pub fn charge(&mut self)

Charges one unit for work already done.

Trait Implementations

impl Debug for PassBudget

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

Formats the value using the given formatter.