Struct Check 

#[non_exhaustive]
pub struct Check {
    pub code: CheckCode,
    pub column: Option<String>,
    pub dimension: Option<QualityDimension>,
    pub expected: Expectation,
    pub observed: Option<MetricValue>,
    pub scope: PolicyScope,
    pub evidence: Evidence,
    pub bounds: Option<CheckBounds>,
    pub baseline: Option<BaselineReading>,
    pub status: CheckStatus,
    pub message: String,
}

One requirement and what the report said about it.

Fields (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.

code: CheckCode

Which requirement this is.

column: Option<String>

The column it concerns, when it concerns one.

dimension: Option<QualityDimension>

The quality dimension it concerns, when it concerns one.

expected: Expectation

The constraint applied.

observed: Option<MetricValue>

The value read from the report. Absent when nothing was read: every unevaluated check, and every require_metric check.

scope: PolicyScope

What the requirement is a statement about.

evidence: Evidence

Whether the data behind observed covers the whole source.

bounds: Option<CheckBounds>

Where the whole-source value lies, when observed came from a retained sample and the report bounds it. A full-source requirement is decided on this interval rather than on observed: it passes when the whole interval meets the requirement, fails when none of it does, and is otherwise not evaluated.

baseline: Option<BaselineReading>

The baseline’s side of a rule about change. Absent on every other rule.

status: CheckStatus

Passed, failed, or not evaluated.

message: String

A fixed sentence naming the outcome.

Deliberately free of numbers: observed and expected carry those, so the prose is identical wherever a value would have been formatted and the Rust and Python implementations cannot drift on rounding inside a string.

Implementations

impl Check

pub fn is_violation(&self) -> bool

True when the check was evaluated and violated.

pub fn not_evaluated(&self) -> Option<&NotEvaluated>

Why the check was not evaluated, if it was not.

Trait Implementations

impl Clone for Check

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 Check

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

Formats the value using the given formatter.

impl PartialEq for Check

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Check

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 Check