Struct FindingEvent 

pub struct FindingEvent {
    pub trigger: Trigger,
    pub policy: PolicyId,
    pub severity: Severity,
    pub code: &'static str,
    pub message: String,
    pub path: Option<EventPath>,
    pub location: Option<FindingLocation>,
    pub fix_available: bool,
}

What: One policy finding as it is reported. String is owned UTF-8 text (sibling &str borrows); Option<T> is “a value or nothing”; &'static str is text baked into the program. Why: The record owns its message and path because events outlive the check that made them. The code is compiled-in text, so a shipped policy cannot emit an empty or misspelled code at run time.

In TS you’d write (pseudocode):

type FindingEvent = { trigger; policyId; severity: 'warn' | 'error'; code; message; path?; pathBytes?; location?; fix: 'none' | 'available' };

Fields

trigger: Trigger

The lifecycle point that ran the policy.

policy: PolicyId

The policy that reported.

severity: Severity

The effective severity, Warn or Error.

code: &'static str

The policy-local code; rendering prefixes the policy name.

message: String

The explanation for the person who ran the command.

path: Option<EventPath>

The repository path the finding is about, when it has one.

location: Option<FindingLocation>

The byte range the finding is about, when it has one.

fix_available: bool

Whether the engine holds a correction for this finding.

Trait Implementations

impl Clone for FindingEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FindingEvent

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

Formats the value using the given formatter.

impl Eq for FindingEvent

impl PartialEq for FindingEvent

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FindingEvent