Struct ConformanceReport 

pub struct ConformanceReport {
    pub provider: ProviderKey,
    pub model: ModelKey,
    pub results: Vec<CheckResult>,
}

The result of one adapter’s conformance run.

Fields

provider: ProviderKey

The provider that was exercised.

model: ModelKey

The model that was exercised. Conformance is per provider-model pair; a passing report says nothing about a sibling model.

results: Vec<CheckResult>

Every check, in Check::run_order order: the feature rows of Check::ALL with the Check::STATUS rows spliced in where they are exercised, which is before RetryClassification rather than at the end.

Implementations

impl ConformanceReport

pub fn new(provider: ProviderKey, model: ModelKey) -> ConformanceReport

An empty report for a provider-model pair.

pub fn push(&mut self, result: CheckResult)

Records one result.

pub fn passed(&self) -> bool

Returns true when nothing failed. A skipped check does not fail a run, but it does mean the adapter is unproven on that row.

pub fn failures(&self) -> Vec<&CheckResult>

Every failing check.

pub fn skipped(&self) -> Vec<&CheckResult>

Every skipped check.

pub fn result(&self, check: Check) -> Option<&CheckResult>

The result of one check, when it ran.

pub fn compatibility_table(&self) -> String

Renders the run as a Markdown compatibility table.

A skipped row renders as unproven, with the reason it was skipped, because a skip is not a pass: it means the run never exercised the behaviour. Copying this table into a documentation page therefore cannot claim more than the run demonstrated — which is the whole reason the method exists rather than a caller filtering results by hand and quietly dropping the skips.

pub fn counts(&self) -> (usize, usize, usize)

Passed, failed and skipped counts.

Trait Implementations

impl Clone for ConformanceReport

fn clone(&self) -> ConformanceReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConformanceReport

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

Formats the value using the given formatter.

impl Display for ConformanceReport

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

Formats the value using the given formatter.

impl Eq for ConformanceReport

impl PartialEq for ConformanceReport

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ConformanceReport