Skip to main content

RuleSpec

Struct RuleSpec 

Source
pub struct RuleSpec {
    pub index: usize,
    pub id: RuleId,
    pub languages: Vec<String>,
    pub severity: Severity,
    pub card: RuleCard,
    pub query: String,
    pub gates: Gates,
    pub timeout: Option<Duration>,
    pub has_reduce: bool,
}
Expand description

A rule as the config declares it.

Fields§

§index: usize

Zero-based position in the config’s rules array.

This is how the engine reaches the handler: the rule object lives in the loaded config, and indexing into it is what lets a function cross the boundary without ever being extracted as a value.

§id: RuleId

Namespaced identifier.

§languages: Vec<String>

Which languages’ grammars the query compiles against, and which files the rule runs on.

A rule runs on a file only when the file’s own language is one of these, and it is then parsed with that grammar. Running every rule against every file with a single declared grammar is what used to turn a .tsx file into a tree of ERROR nodes — silently, since a query simply matches nothing inside one.

§severity: Severity

Severity as the rule declares it, before config overrides.

§card: RuleCard

The rule card.

§query: String

The tree-sitter query gating the handler.

§gates: Gates

Pre-parse gates.

§timeout: Option<Duration>

A per-invocation budget overriding the default.

§has_reduce: bool

Whether the rule has a reduce phase.

Trait Implementations§

Source§

impl Clone for RuleSpec

Source§

fn clone(&self) -> RuleSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RuleSpec

Source§

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

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

impl Eq for RuleSpec

Source§

impl PartialEq for RuleSpec

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for RuleSpec

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> ParallelSend for T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.