Skip to main content

Module engine_notes

Module engine_notes 

Source
Expand description

Provenance notes attached to findings when the engine has hit an internal budget, widening, or lowering cap.

Each note carries a LossDirection classification. crate::evidence::compute_confidence caps confidence at Medium for OverReport/Bail notes, and crate::rank applies a direction-aware completeness penalty.

Enums§

CapHitReason
Why a fix-point loop hit its safety cap. Distinguishes “raise the cap” cases from non-monotonicity bugs in cap-hit telemetry. Serialized as a tagged snake_case enum for SARIF/JSON consumers.
EngineNote
A single provenance event recorded during analysis.
LossDirection
Direction of precision loss encoded by an EngineNote. Variants are ordered by worsening credibility impact; combine takes the max.

Functions§

push_unique
Push-if-not-present.
worst_direction
Worst non-informational direction across a slice of notes, or None if the slice is empty or only carries informational notes.