Struct Gate 

pub struct Gate {
    pub id: String,
    pub severity: Severity,
    pub outcome: Outcome,
}

One contract: an identifier, a severity and an outcome.

Fields

id: String

Stable identifier, e.g. "rdap-reachable".

severity: Severity

Whether this gate can halt the run.

outcome: Outcome

The evaluated outcome.

Implementations

impl Gate

pub fn new(id: impl Into<String>, outcome: Outcome) -> Self

A blocking gate with an explicit outcome.

pub fn pass(id: impl Into<String>) -> Self

A blocking gate that passed.

pub fn fail(id: impl Into<String>, reason: impl Into<String>) -> Self

A blocking gate that failed, with the reason.

pub fn unevaluable(id: impl Into<String>, reason: impl Into<String>) -> Self

A blocking gate that could not be checked, with the reason.

pub fn advisory(self) -> Self

Downgrade this gate to advisory.

pub fn check( id: impl Into<String>, held: bool, reason: impl Into<String>, ) -> Self

Build a gate from a boolean check, with the reason used when it is false.

use gate_contract::Gate;
let g = Gate::check("page-count-nonzero", 12 > 0, "no pages were produced");
assert!(g.outcome.passed());

pub fn check_known<T, F>( id: impl Into<String>, value: &Known<T>, predicate: F, reason: impl Into<String>, ) -> Self

where F: FnOnce(&T) -> bool,

Build a gate from a value that may be unknown.

Known(v) is handed to predicate; Unknown short-circuits to Outcome::Unevaluable, which is what makes the missing input halt a blocking gate instead of silently passing it.

use gate_contract::{Gate, Known, Outcome};

let measured: Known<u32> = Known::Unknown;
let g = Gate::check_known("coverage-above-floor", &measured, |c| *c >= 50, "below floor");
assert!(matches!(g.outcome, Outcome::Unevaluable(_)));

pub fn halts(&self) -> bool

Whether this gate, on its own, halts the run.

Trait Implementations

impl Clone for Gate

fn clone(&self) -> Gate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gate

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

Formats the value using the given formatter.

impl Display for Gate

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

Formats the value using the given formatter.

impl Eq for Gate

impl PartialEq for Gate

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Gate