Skip to main content

RuleConfig

Struct RuleConfig 

Source
pub struct RuleConfig {
Show 22 fields pub id: String, pub severity: Severity, pub message: String, pub languages: Vec<String>, pub patterns: Vec<String>, pub paths: Vec<String>, pub exclude_paths: Vec<String>, pub ignore_comments: bool, pub ignore_strings: bool, pub match_mode: MatchMode, pub multiline: bool, pub multiline_window: Option<u32>, pub context_patterns: Vec<String>, pub context_window: Option<u32>, pub escalate_patterns: Vec<String>, pub escalate_window: Option<u32>, pub escalate_to: Option<Severity>, pub depends_on: Vec<String>, pub help: Option<String>, pub url: Option<String>, pub tags: Vec<String>, pub test_cases: Vec<RuleTestCase>,
}

Fields§

§id: String§severity: Severity§message: String§languages: Vec<String>

Optional language tags (e.g. “rust”). Empty means “all”.

§patterns: Vec<String>

One or more regex patterns.

§paths: Vec<String>

Include path globs. Empty means “all”.

§exclude_paths: Vec<String>

Exclude path globs.

§ignore_comments: bool§ignore_strings: bool§match_mode: MatchMode

Matching mode:

  • any (default): emit when patterns match
  • absent: emit when patterns do not match in the scoped file
§multiline: bool

Enable multi-line matching across consecutive scoped lines.

§multiline_window: Option<u32>

Number of consecutive scoped lines to include in a multiline window. If omitted and multiline=true, a default of 2 lines is used.

§context_patterns: Vec<String>

Optional context patterns that must match near a primary match.

§context_window: Option<u32>

Context search window (lines before/after the matched line). If omitted and context_patterns are set, a default of 3 is used.

§escalate_patterns: Vec<String>

Optional patterns that escalate severity when found near a match.

§escalate_window: Option<u32>

Escalation search window (lines before/after the matched line). If omitted and escalate_patterns are set, a default of 0 (same line) is used.

§escalate_to: Option<Severity>

Escalation target severity. Defaults to error when escalation patterns match.

§depends_on: Vec<String>

Rule dependencies. This rule is only evaluated in files where all dependencies matched.

§help: Option<String>

Optional help text explaining how to fix violations.

§url: Option<String>

Optional URL with more information about the rule.

§tags: Vec<String>

Tags for grouping/filtering rules (e.g., “debug”, “security”, “style”).

§test_cases: Vec<RuleTestCase>

Test cases for validating this rule.

Trait Implementations§

Source§

impl Clone for RuleConfig

Source§

fn clone(&self) -> RuleConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RuleConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for RuleConfig

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for RuleConfig

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl PartialEq for RuleConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for RuleConfig

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for RuleConfig

Source§

impl StructuralPartialEq for RuleConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,