Struct SanitizeReport 

pub struct SanitizeReport {
    pub metadata: ReportMetadata,
    pub summary: ReportSummary,
    pub files: Vec<FileReport>,
}

Top-level sanitization report.

Serialized to JSON via Self::to_json / Self::to_json_pretty. Never contains original secret values.

Fields

metadata: ReportMetadata

Tool metadata and flags.

summary: ReportSummary

Aggregated summary across all files.

files: Vec<FileReport>

Per-file details. Each entry may include log_context when --extract-context was used.

Implementations

impl SanitizeReport

pub fn to_json(&self) -> Result<String>

Serialize the report as compact JSON.

Errors

Returns serde_json::Error if serialization fails.

pub fn to_json_pretty(&self) -> Result<String>

Serialize the report as pretty-printed JSON.

Errors

Returns serde_json::Error if serialization fails.

pub fn to_sarif(&self) -> Result<String>

Serialize the report as SARIF 2.1.0 JSON.

SARIF (Static Analysis Results Interchange Format) is consumed natively by GitHub Advanced Security, VS Code Problems panel, and most SIEM tooling. Results are file-level (no line numbers — the sanitize engine operates on byte streams and does not record source positions).

Errors

Returns serde_json::Error if serialization fails.

pub fn to_html(&self) -> String

Render the report as a self-contained HTML document.

The output has no external dependencies (no CDN, no external fonts). Includes a summary dashboard, per-pattern totals, and a per-file table. Dark mode is supported via prefers-color-scheme.

Trait Implementations

impl Clone for SanitizeReport

fn clone(&self) -> SanitizeReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SanitizeReport

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

Formats the value using the given formatter.

impl Serialize for SanitizeReport

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.