Struct PolicyViolationFinding 

pub struct PolicyViolationFinding {
    pub violation: PolicyViolation,
    pub finding_id: Option<String>,
    pub actions: Vec<IssueAction>,
    pub introduced: Option<AuditIntroduced>,
}

Wire-shape envelope for a PolicyViolation finding. Carries actions for replacing the banned call, import, or effect, or suppressing it with a scoped policy-violation:<pack>/<rule-id> token.

Fields

violation: PolicyViolation

The underlying rule-pack policy entry.

finding_id: Option<String>

Stable id of this finding: dc1:<rule>:<16 hex digits>, with a ~<k> suffix when several findings of one type share an identity. Line and column are not inputs, so the id survives line shifts, reformats and reorders. A rename of the file or the symbol gives a new id. Absent in output from older versions.

actions: Vec<IssueAction>

Suggested next steps.

introduced: Option<AuditIntroduced>

Set by the audit pass when this finding is introduced relative to the merge-base.

Implementations

impl PolicyViolationFinding

pub fn with_actions(violation: PolicyViolation) -> PolicyViolationFinding

Build the wrapper from a raw PolicyViolation.

Trait Implementations

impl Clone for PolicyViolationFinding

fn clone(&self) -> PolicyViolationFinding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolicyViolationFinding

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PolicyViolationFinding

fn deserialize<__D>( __deserializer: __D, ) -> Result<PolicyViolationFinding, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IdentifiedFinding for PolicyViolationFinding

fn rule_token(&self) -> &'static str

The canonical issue code of this finding.

fn identity_parts(&self, p: &IdentityPaths<'_>) -> Vec<String>

The parts that name the subject of this finding. Never a line or a column.

fn tiebreak_position(&self) -> (u32, u32, u32)

Line, column and span start. Used only to order findings that share a base id.

fn finding_id(&self) -> Option<&str>

The stamped id, or None before the stamping pass.

fn set_finding_id(&mut self, id: Option<String>)

Write the id.

fn canonical_key(&self, paths: &IdentityPaths<'_>) -> String

The canonical key of this finding: the readable form of the id input. See dead_code_canonical_key.

impl JsonSchema for PolicyViolationFinding

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for PolicyViolationFinding

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

where __S: Serializer,

Serialize this value into the given Serde serializer.