Struct BudgetVerdict 

pub struct BudgetVerdict { /* private fields */ }

A report’s total judged against a Budget.

Implementations

impl BudgetVerdict

pub fn budget(&self) -> Budget

The budget judged against.

pub fn floor(&self) -> EstimatedUsd

The total’s floor: the whole estimate when Self::is_lower_bound is false.

pub fn is_lower_bound(&self) -> bool

Whether the floor is a lower bound, because a line on the report is unpriced.

pub fn unpriced_phases(&self) -> &[&'static str]

The phases whose lines are unpriced, sorted: what the floor leaves out.

pub fn breached(&self) -> bool

Whether the floor is over the ceiling. At the ceiling is within it.

pub fn aborts(&self) -> bool

Whether the caller’s judgement refuses this report: breached, with OnBreach::Abort.

pub fn overage(&self) -> Option<EstimatedUsd>

How far the floor is over the ceiling, when it is: at least this much for a lower bound.

pub fn basis(&self) -> &'static str

"exact" or "lower-bound": what the floor is.

pub fn render(&self) -> String

One line for a human: the figure, the ceiling, and what an unpriced line leaves open.

An under-budget verdict from a lower bound says so, because “within budget” without that half would be the report lying by omission, the figure COST-4 keeps honest.

pub fn render_dense(&self) -> String

The dense line: budget, the ceiling, the basis, breached or within, and the overage or -.

pub fn to_json(&self) -> Value

The verdict as JSON: maxUsd, onBreach, basis, breached and overageAtLeastUsd, dollars as strings.

Trait Implementations

impl Clone for BudgetVerdict

fn clone(&self) -> BudgetVerdict

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BudgetVerdict

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

Formats the value using the given formatter.

impl Eq for BudgetVerdict

impl PartialEq for BudgetVerdict

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BudgetVerdict