Struct Suppression 

pub struct Suppression {
    pub line: u32,
    pub comment_line: u32,
    pub target: Option<SuppressionTarget>,
}

A suppression directive parsed from a source comment.

Examples

use fallow_types::suppress::{Suppression, IssueKind};

// File-wide suppression (line 0, no specific kind)
let file_wide = Suppression::all(0, 1);
assert_eq!(file_wide.line, 0);

// Line-specific suppression for unused exports
let line_suppress = Suppression::issue(42, 41, IssueKind::UnusedExport);
assert_eq!(line_suppress.issue_kind_target(), Some(IssueKind::UnusedExport));

Fields

line: u32

1-based line this suppression applies to. 0 = file-wide suppression.

comment_line: u32

1-based line where the suppression comment itself appears. For fallow-ignore-next-line, this is line - 1. For fallow-ignore-file, this is the actual line of the comment in the source.

target: Option<SuppressionTarget>

None = suppress all issue kinds on this line or file.

Implementations

impl Suppression

pub const fn all(line: u32, comment_line: u32) -> Suppression

Build a blanket suppression.

pub const fn issue(line: u32, comment_line: u32, kind: IssueKind) -> Suppression

Build a regular issue-kind suppression.

pub fn policy_rule( line: u32, comment_line: u32, pack: impl Into<String>, rule_id: impl Into<String>, ) -> Suppression

Build a scoped rule-pack policy suppression.

pub const fn issue_kind_target(&self) -> Option<IssueKind>

The bare issue kind if this suppression targets one.

pub const fn policy_rule_target(&self) -> Option<&PolicyRuleSuppression>

The scoped policy target if this suppression targets one rule-pack rule.

pub fn target_token(&self) -> Option<String>

Canonical token for this suppression, or None for blanket comments.

pub const fn applies_to_line(&self, line: u32) -> bool

Whether the comment applies to line.

pub fn matches_issue_kind(&self, line: u32, kind: IssueKind) -> bool

Whether this suppression covers a regular issue kind on a line.

Scoped policy-rule targets intentionally do not match this generic predicate. Policy detection uses Self::matches_policy_rule so the exact pack and rule id are available.

pub fn matches_policy_rule(&self, line: u32, pack: &str, rule_id: &str) -> bool

Whether this suppression covers a policy finding on a line.

Trait Implementations

impl Clone for Suppression

fn clone(&self) -> Suppression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Suppression

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

Formats the value using the given formatter.