Struct StaleSuppression 

pub struct StaleSuppression {
    pub path: PathBuf,
    pub line: u32,
    pub col: u32,
    pub origin: SuppressionOrigin,
    pub missing_reason: bool,
    pub finding_id: Option<String>,
    pub actions: Vec<IssueAction>,
    pub effective_severity: Option<EffectiveSeverity>,
}

A suppression comment or JSDoc tag that no longer matches any issue.

Fields

path: PathBuf

File containing the stale suppression.

line: u32

1-based line number of the suppression comment or tag.

col: u32

0-based byte column offset.

origin: SuppressionOrigin

The origin and details of the stale suppression.

missing_reason: bool

True when rules.require-suppression-reason reported a suppression comment or tag that has no reason.

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. Always emitted.

effective_severity: Option<EffectiveSeverity>

Gate severity of this finding after rules and overrides[].rules resolve for its path. CI formats read it for the annotation, SARIF and CodeClimate level. Absent in output from older versions. Not part of the finding identity, baseline keys or fingerprints.

Implementations

impl StaleSuppression

pub fn actions_for(missing_reason: bool) -> Vec<IssueAction>

Build the typed action list for this suppression finding.

pub fn description(&self) -> String

Produce a human-readable description of this stale suppression.

pub fn explanation(&self) -> String

Produce an explanation of why this suppression is stale.

For comment suppressions where kind_known == false, surfaces the unknown token plus a Levenshtein “did you mean?” hint when one is within edit distance 2. Other tokens on the same comment line still apply normally (see issue #449).

pub fn display_message(&self) -> String

Per-format display message combining description() and explanation() for the unknown-kind case so SARIF, CodeClimate, and compact consumers surface the typo-fix copy and Levenshtein hint without needing to branch on origin.kind_known themselves. Stale-but-known and JSDoc origins keep the bare description() so existing wire bytes stay unchanged. See issue #449.

Trait Implementations

impl Clone for StaleSuppression

fn clone(&self) -> StaleSuppression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StaleSuppression

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StaleSuppression

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GatedFinding for StaleSuppression

fn effective_severity(&self) -> Option<EffectiveSeverity>

The gate severity, or None when no value was written.

fn set_effective_severity(&mut self, severity: Option<EffectiveSeverity>)

Write the gate severity.

impl IdentifiedFinding for StaleSuppression

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 StaleSuppression

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 RuleSeverity for StaleSuppression

fn rule_severity(&self, source: &SeveritySource<'_>) -> Severity

The severity of this finding under source.

fn uniform_severity(source: &SeveritySource<'_>) -> Option<Severity>

The severity that every finding of this kind has under source, or None when the severity can differ from finding to finding.

impl Serialize for StaleSuppression

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.