Skip to main content

ContractReport

Struct ContractReport 

Source
pub struct ContractReport { /* private fields */ }
Expand description

A report containing stable check identities and their outcomes.

This report describes check evidence only. It does not establish that the contract run completed, that its execution succeeded, or that cleanup succeeded. Use ContractRun::assert_satisfied or ContractRun::assert_satisfied_with to validate the complete run.

§Examples

use qubit_fs_testkit::{FileSystemContract, FileSystemContractSuite};

let fixture = RustdocSyncFixture::new();
let mut suite = FileSystemContractSuite::new(&fixture);
suite.run_contract(FileSystemContract::Properties);
assert!(!suite.run().report().checks().is_empty());

Implementations§

Source§

impl ContractReport

Source

pub fn checks(&self) -> &[ContractCheck]

Returns checks in execution order.

§Returns

The recorded checks in the order their outcomes were produced.

Source

pub fn requirements_satisfied(&self) -> bool

Returns whether the registered contract requirements have evidence.

An unavailable optional probe is acceptable. A probe that ran and failed is always a failure, even when it was optional. This checks report evidence only; it does not include execution or cleanup status. Use ContractRun::requirements_satisfied to check the complete run.

Source

pub fn requirements_satisfied_with(&self, required: &[ContractCheckId]) -> bool

Also requires evidence for the caller-selected optional checks.

A requested identity absent from this run cannot satisfy the request. This checks report evidence only; it does not include execution or cleanup status. Use ContractRun::requirements_satisfied_with to check the complete run.

§Parameters
  • required: Optional check identities that must have evidence.
§Returns

Whether the registered requirements and selected optional checks are satisfied.

Source

pub fn all_applicable_checks_verified(&self) -> bool

Returns whether every applicable check, including optional probes, was verified. This checks report evidence only; it does not include execution or cleanup status. Use ContractRun::all_applicable_checks_verified to check the complete run.

§Returns

Whether all applicable checks have evidence, including optional probes.

Source

pub fn assert_satisfied(&self)

Panics if registered requirements lack successful evidence. This checks report evidence only; it does not include execution or cleanup status. Use ContractRun::assert_satisfied to validate the complete run.

§Panics

Panics with a summary when any registered requirement lacks successful evidence.

Source

pub fn assert_satisfied_with(&self, required: &[ContractCheckId])

Also requires the selected optional probes to have evidence. This checks report evidence only; it does not include execution or cleanup status. Use ContractRun::assert_satisfied_with to validate the complete run.

§Panics

Panics when any required check or selected optional probe is unverified.

§Parameters
  • required: Optional check identities that must have evidence.

Trait Implementations§

Source§

impl Clone for ContractReport

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 ContractReport

Source§

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

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

impl Eq for ContractReport

Source§

impl PartialEq for ContractReport

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 StructuralPartialEq for ContractReport

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