Enum OnBreach 

pub enum OnBreach {
    Warn,
    Abort,
}

What a breached budget does: report it, or refuse the plan. There is no default.

The total a budget is compared against is a lower bound whenever a line is unpriced (COST-4), so a breach found from one has already been exceeded by an unknown margin. Whether that warrants a warning or a refusal depends on what the caller is gating (a dashboard wants the report either way, a CI gate wants the refusal), and a default would quietly make that judgement for them. So Budget::new takes one, and so does every surface: cost --max-cost requires --on-breach.

Variants

Warn

Report as usual, with the breach as a warning.

Abort

Report as usual, then refuse: the budget the caller set does not hold.

Implementations

impl OnBreach

pub const ALL: [OnBreach; 2]

Every judgement, for a surface that publishes the closed set.

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

"warn" or "abort", the spelling every surface takes and reports.

Trait Implementations

impl Clone for OnBreach

fn clone(&self) -> OnBreach

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OnBreach

impl Debug for OnBreach

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

Formats the value using the given formatter.

impl Eq for OnBreach

impl FromStr for OnBreach

type Err = Error

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<OnBreach, Error>

Parses a string s to return a value of this type.

impl PartialEq for OnBreach

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OnBreach