Struct Rule 

pub struct Rule {

    pub id: RuleId,
    pub language: Language,
    pub severity: Severity,
    pub message: String,
    pub note: Option<String>,
    pub category: Option<Category>,
    pub fix: Option<String>,
    pub rule: Value,
    pub metric: Option<Metric>,
    pub threshold: Option<f64>,
    pub source_dir: Option<PathBuf>,
    pub files: Option<Vec<String>>,
    pub ignores: Option<Vec<String>>,
    pub enabled: bool,
    pub skip_test_code: bool,
    pub tests: Option<RuleTests>,
    pub ai_check: Option<AiCheck>,
}

Fields

id: RuleId

language: Language

severity: Severity

message: String

note: Option<String>

category: Option<Category>

fix: Option<String>

rule: Value

metric: Option<Metric>

File-level metric evaluated instead of rule. Mutually exclusive with it.

threshold: Option<f64>

The value metric must exceed for the rule to fire. Required with metric.

source_dir: Option<PathBuf>

Directory a custom rule was loaded from, used to resolve test fixture paths. None for builtin rules, which resolve against BuiltinRules.

files: Option<Vec<String>>

ignores: Option<Vec<String>>

enabled: bool

Drop findings located inside #[cfg(test)] blocks of scanned Rust files. Complements ignores, which only filters whole files by path.

skip_test_code: bool

tests: Option<RuleTests>

ai_check: Option<AiCheck>

When set, matches of rule are candidates confirmed by an LLM before being reported. See AiCheck. The AST scanner ignores this field.

Implementations

impl Rule

pub fn effective_category(&self) -> Category

The rule’s category, resolving an unset category to the default (Correctness), the way the scanner treats it.

pub fn is_metric(&self) -> bool

Whether this rule measures a file-level metric instead of matching AST.

pub fn metric_spec(&self) -> Option<(Metric, f64)>

The metric and threshold of a file-level rule, None for AST rules.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Rule

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

where __S: Serializer,

Serialize this value into the given Serde serializer.