Skip to main content

Module checks

Module checks 

Source
Expand description

Checks: what one is, and what every one of them promises.

A check is a pure function from a TraceContext to findings, registered under a stable ID that requirement-registry entries reference. The contract for every check:

  • Falsifiable: the corpus contains at least one trace it passes and one it fails (enforced by the corpus invariant test).
  • Deterministic: findings are emitted in event order with stable details.
  • Lenient input, precise output: checks never refuse malformed messages — they report them.
  • Its own clause, and no neighbour’s: the engine attributes a check’s finding to every requirement naming it, so a check that bundles adjacent rules makes each of them unable to say which one broke. Requirements share a check only where they state one rule across several sections.

The registered list itself lives in the private inventory module, re-exported here as ALL.

Structs§

Check
A registered check.
CheckOutcome
What running one check produced.
FindingSink
Collects findings on behalf of one check, stamping each with the check ID.

Statics§

ALL
Every check implemented by this build, in stable order.

Functions§

find
Looks up a check by its stable ID.