Skip to main content

SecuritySummaryOutput

Type Alias SecuritySummaryOutput 

Source
pub type SecuritySummaryOutput = SecuritySummaryOutput<SecurityOutputConfig, SecurityGate>;
Expand description

Concrete fallow security summary envelope.

Aliased Type§

pub struct SecuritySummaryOutput {
    pub schema_version: SecuritySchemaVersion,
    pub version: ToolVersion,
    pub elapsed_ms: ElapsedMs,
    pub config: SecurityOutputConfig<Severity>,
    pub gate_outcomes: Option<GateOutcomes>,
    pub request_outcomes: Option<RequestOutcomes>,
    pub meta: Option<Meta>,
    pub gate: Option<SecurityGate<SecurityGateMode>>,
    pub workspace_diagnostics: Vec<WorkspaceDiagnostic>,
    pub summary: SecuritySummary,
}

Fields§

§schema_version: SecuritySchemaVersion

Schema version of this envelope.

§version: ToolVersion

Fallow CLI version that produced this output.

§elapsed_ms: ElapsedMs

Wall-clock milliseconds spent producing the report.

§config: SecurityOutputConfig<Severity>

Privacy-safe config context relevant to security candidate generation.

§gate_outcomes: Option<GateOutcomes>

The verdict of every gate this run evaluated, keyed by name. The CLI always emits it, with the command’s default exit rule in it also when no flag armed a gate, so a CI integration reads the verdict instead of guessing from a process status it usually cannot see. A gate fails the build when status is fail AND enforced is true. The typed programmatic API runs no CLI gate and leaves it absent. See [crate::GateOutcomes].

§request_outcomes: Option<RequestOutcomes>

Every narrowing or shaping request this run RECEIVED, keyed by name, absent when it was asked for nothing. An entry whose status is not applied means the run could not do what it was asked and reported something WIDER instead, so what follows is a valid report of a scope nobody requested. Honoured requests are published too, with status: "applied", so an absent object means “nothing was asked for”, never “nothing failed”. See [crate::RequestOutcomes].

§meta: Option<Meta>

Security-specific rule and field metadata, emitted with --explain.

§gate: Option<SecurityGate<SecurityGateMode>>

Gate verdict, present only when --gate <mode> was set.

§workspace_diagnostics: Vec<WorkspaceDiagnostic>

Diagnostics owned by the full security analysis summarized here.

§summary: SecuritySummary

Aggregate security counts after all filters, gates, and scopes.