Struct Debt 

pub struct Debt { /* private fields */ }

The recorded debt.

Implementations

impl Debt

pub fn is_empty(&self) -> bool

Whether nothing is recorded.

pub fn record( &mut self, gate: GateId, path: &str, dimension: &'static str, value: Recorded, )

Record one dimension.

pub fn recorded( &self, gate: GateId, path: &str, dimension: &str, ) -> Option<Recorded>

What is recorded for one dimension of one path.

pub fn recorded_for( &self, gate: GateId, ) -> Vec<(String, &'static str, Recorded)>

Every recorded dimension of one gate, as (path, dimension, value).

pub fn baseline(measurements: &[Measurement]) -> Self

The debt a set of measurements becomes: every violating dimension, at the measurement.

pub fn tighten(&self, measurements: &[Measurement]) -> Tightened

The debt after every ceiling comes down to its measurement.

A ceiling never rises and a cleared exception is never reinstated. A dimension within its budget, a corrected condition, and a path the gate no longer measures all leave the file. A measurement above its ceiling is reported and left alone, because the gate already fails on it and lowering is not the fix.

pub fn parse(text: &str) -> Result<Self, DebtError>

Parse a debt file.

Errors

DebtError::Shape when the text is not a mapping of this schema, and DebtError::Malformed naming the gate and path of the first entry that is not of the expected shape. Neither falls back to the empty debt: a file that quietly stops applying turns a green commit into a false pass.

pub fn read(root: &Utf8Path) -> Result<Self, DebtError>

Read the debt an instance carries.

An absent file is the empty debt and never an error: nothing delivers the file, so absence is the ordinary state.

Errors

DebtError::TwoFormats when the legacy list sits beside the file, and the parse errors of Self::parse.

pub fn render(&self) -> String

The file’s text, in the one shape this binary writes.

Trait Implementations

impl Clone for Debt

fn clone(&self) -> Debt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Debt

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

Formats the value using the given formatter.

impl Default for Debt

fn default() -> Debt

Returns the “default value” for a type.

impl Eq for Debt

impl PartialEq for Debt

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Debt