Skip to main content

GateResult

Struct GateResult 

Source
#[non_exhaustive]
pub struct GateResult { pub verdict: Verdict, pub scope: PolicyScope, pub evidence: Evidence, pub checks: Vec<Check>, pub baseline: Option<BaselineComparison>, pub generator: Option<ReportGenerator>, pub source_identity: Option<SourceIdentity>, }
Expand description

The structured result of evaluating a QualityPolicy.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§verdict: Verdict

The overall outcome.

§scope: PolicyScope

The scope every requirement was evaluated under.

§evidence: Evidence

Whether the scan itself covered the whole source. A single check’s evidence can be weaker still, when its metric came from a retained sample of the scanned rows.

§checks: Vec<Check>

Every requirement, in evaluation order.

§baseline: Option<BaselineComparison>

The reports compared, when the policy was evaluated against a baseline. Absent otherwise.

§generator: Option<ReportGenerator>

The build that wrote the report evaluated, which decided the metrics the verdict reads. None (serialized as null) when the report did not record one. The build evaluating the policy can be another.

§source_identity: Option<SourceIdentity>

The caller’s version of the source the report describes, None (serialized as null) when none was recorded.

Implementations§

Source§

impl GateResult

Source

pub fn passed(&self) -> bool

True only for Verdict::Pass.

An inconclusive result is not a pass: reading it as one is the mistake this API exists to prevent. Callers that need to tell “violated” from “could not tell” should match on GateResult::verdict.

Source

pub fn violations(&self) -> impl Iterator<Item = &Check>

The checks that were evaluated and violated.

Source

pub fn unevaluated(&self) -> impl Iterator<Item = &Check>

The checks that could not be evaluated.

Trait Implementations§

Source§

impl Clone for GateResult

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GateResult

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for GateResult

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for GateResult

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for GateResult

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V