Struct GateOutcomes 

pub struct GateOutcomes(/* private fields */);

The verdict of every gate a run evaluated, keyed by name.

A gate is armed by a flag or by config. The default exit rule of a command is always in the object, also when no flag armed a gate: error-severity-findings on dead-code, check and the combined run (with health-findings when the combined run analyzed health), health-findings on health, security-advisory on security and audit-verdict on audit. A reader of the JSON sees a failing run without the exit code. dupes has no default exit rule, so a dupes run that armed no gate carries no object and always exits 0.

An empty object is never emitted. The typed programmatic API runs no CLI gate and leaves the object absent.

The names this build can emit are error-severity-findings, regression, stale-baseline, duplication-threshold, health-min-score, health-min-severity, health-findings, health-coverage-gaps, health-runtime-coverage, security, security-advisory, audit-verdict, type-aware-require and parse-error. The set is OPEN: a name a consumer does not recognise means “some gate”, not an error.

Implementations

impl GateOutcomes

pub fn new() -> Self

An empty set, which serializes to nothing once Self::into_option has been applied.

pub fn insert(&mut self, name: GateName, outcome: GateOutcome)

Record one gate’s outcome, replacing any previous entry for that name.

pub fn insert_if(&mut self, name: GateName, outcome: Option<GateOutcome>)

Record one gate’s outcome when it ran at all.

pub fn get(&self, name: GateName) -> Option<&GateOutcome>

Read one gate’s outcome.

pub fn fails_run(&self) -> bool

Whether a gate of the set fails the run: its status is fail and it is enforced.

pub fn is_empty(&self) -> bool

Whether the set holds no gate.

pub fn into_option(self) -> Option<Self>

Collapse an empty set to None, which is how the field stays absent on a run that evaluated no gate.

Trait Implementations

impl Clone for GateOutcomes

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GateOutcomes

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

Formats the value using the given formatter.

impl Default for GateOutcomes

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for GateOutcomes

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for GateOutcomes

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GateOutcomes