Struct Rule 

pub struct Rule {
    pub id: String,
    pub name: String,
    pub severity: Severity,
    pub category: Option<String>,
    pub query: PatternQuery,
    pub message: String,
    pub suggestion: Option<String>,
    pub scope: Vec<String>,
    pub fix: Option<Value>,
}

Lint rule definition with optional fix

Fields

id: String

Unique identifier (e.g., “RL001”)

name: String

Human-readable name

severity: Severity

Severity level

category: Option<String>

Category for grouping

query: PatternQuery

Detection query

message: String

Error message (supports variable interpolation)

suggestion: Option<String>

Suggestion text (human-readable hint, not executable)

scope: Vec<String>

Target code scopes where this rule applies.

When non-empty, the rule only fires on symbols within the specified scopes. Valid values: “lib”, “bin”, “test”. When empty (default), the rule applies to all scopes.

scope: [lib]           # Library code only
scope: [lib, bin]      # Production code (lib + bin)

fix: Option<Value>

Fix specification (Intent or MutationSpec as JSON)

Default format is Intent (public DSL):

fix:
  type: UnwrapToQuestion
  target_fn: "$MATCH"

For builtin rules, MutationSpec can be used with _kind: mutation_spec:

fix:
  _kind: mutation_spec
  type: UnwrapToQuestion
  target: ...

Implementations

impl Rule

pub fn new( id: impl Into<String>, name: impl Into<String>, severity: Severity, query: PatternQuery, message: impl Into<String>, ) -> Self

Create a new rule

pub fn with_category(self, category: impl Into<String>) -> Self

Set category

pub fn with_suggestion(self, suggestion: impl Into<String>) -> Self

Set suggestion

pub fn with_fix(self, fix: Value) -> Self

Set fix specification (as JSON Value)

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 JsonSchema for Rule

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 PartialEq for Rule

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for Rule