Skip to main content

write_sarif_with_suppressed

Function write_sarif_with_suppressed 

Source
pub fn write_sarif_with_suppressed<W: Write>(
    active: &[OffenderRecord],
    in_source: &[OffenderRecord],
    baseline: &[OffenderRecord],
    writer: W,
) -> Result<()>
Expand description

Write a SARIF 2.1.0 document that also surfaces suppressed offenders.

active offenders are emitted as ordinary results (open findings). in_source and baseline offenders are emitted with a SARIF suppressions entry (kind: "inSource" and kind: "external" respectively) so consumers such as GitHub Code Scanning render them as suppressed/closed alerts rather than active findings — the debt stays visible without counting against the open-alert total. This backs bca check --report-suppressed, which keeps suppression-marker and baseline-covered offenders out of the gate yet records them in the code-scan report.

write_sarif is the active-only special case.

§Errors

Same contract as write_sarif: any io::Error from writer, or a serialisation failure mapped to io::Error.