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 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>

Every gate this run ARMED, keyed by name, absent when it armed none. Each entry is the same rule that decides the exit code, 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. Armed, not evaluated: fallow’s default severity rules fail a run with no flag at all, so an absent object means “no gate was asked for”, never “nothing failed”. See [crate::GateOutcomes].

§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.