Struct PolicyFinding 

pub struct PolicyFinding {
    pub code: &'static str,
    pub message: String,
    pub path: Option<EventPath>,
    pub location: Option<FindingLocation>,
    pub fix_available: bool,
}

What: One thing a policy reports. A struct is a record with named fields; String is owned UTF-8 text; Option<T> is “a value or nothing”; &'static str is text baked into the program. Why: A policy describes what it found; the engine adds the trigger, the policy name and the configured severity when it turns the finding into an event.

In TS you’d write (pseudocode):

type PolicyFinding = { code: string; message: string; path?: EventPath; location?: FindingLocation; patch?: PolicyPatch };

Fields

code: &'static str

The policy-local code, lower-case words joined by hyphens.

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 policy proposed a correction for this finding.

Trait Implementations

impl Clone for PolicyFinding

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 PolicyFinding

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

Formats the value using the given formatter.

impl Eq for PolicyFinding

impl PartialEq for PolicyFinding

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PolicyFinding