Struct HeadroomShortfall 

pub struct HeadroomShortfall {
    pub run_idx: u32,
    pub required_bytes: u64,
    pub available_bytes: u64,
    pub volume: String,
    pub peak_gated: bool,
}

The numbers behind an HeadroomDecision::Abort, rendered into the operator-facing error.

Fields

run_idx: u32

Zero-based index of the run that would have run next.

required_bytes: u64

Bytes the guard required to be free before the run.

available_bytes: u64

Bytes actually free on the worktree volume.

volume: String

The volume/path the readings were taken on (for the message).

peak_gated: bool

Whether required_bytes came from a measured prior-run peak (true, run-1..N) or the absolute floor alone (false, run-0). Drives the message so it never over-claims a peak guarantee for run-0.

Implementations

impl HeadroomShortfall

pub fn message(&self) -> String

Actionable, number-carrying abort message. Names the run, the deficit (with exact bytes so a near-miss is unambiguous), whether the bound was peak-measured or the floor backstop, and the two remedies an operator actually has.

Trait Implementations

impl Clone for HeadroomShortfall

fn clone(&self) -> HeadroomShortfall

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeadroomShortfall

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

Formats the value using the given formatter.

impl Eq for HeadroomShortfall

impl PartialEq for HeadroomShortfall

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HeadroomShortfall