Struct ToolSecurityList 

pub struct ToolSecurityList {
    pub schema: &'static str,
    pub coverage: Coverage,
    pub report: Option<SecurityListReport>,
    pub no_result_reason: Option<String>,
}

The tool-surface security list result.

Why report is an Option and not an empty listing

The hazard this shape addresses is that a listing which had nothing to list looks exactly like a clean repository once it is serialised. A listing has findings: usize, and 0 is the good answer — so a Coverage::NoAnalyzerOnRecord result must not produce a listing at all. It does not: report is None and is skipped entirely in JSON, so a consumer reaching for findings finds nothing rather than nothing-wrong. coverage says the same thing in one word for a consumer that reads only that.

Fields

schema: &'static str

Stable schema tag (TOOL_SECURITY_LIST_SCHEMA).

coverage: Coverage

Whether any analyzer result is on record. Always present.

report: Option<SecurityListReport>

The listing. Absent unless an analyzer result is on record.

no_result_reason: Option<String>

Why there is nothing to list, and what to run. Present exactly when coverage is no-analyzer-on-record.

Trait Implementations

impl Clone for ToolSecurityList

fn clone(&self) -> ToolSecurityList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolSecurityList

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

Formats the value using the given formatter.

impl Serialize for ToolSecurityList

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

where __S: Serializer,

Serialize this value into the given Serde serializer.