Skip to main content

Rule

Struct Rule 

Source
pub struct Rule {
    pub id: String,
    pub pattern: String,
    pub severity: Severity,
    pub message: Option<Template>,
    pub callback: Option<CallbackRef>,
    pub parser: Option<CallbackRef>,
    pub fix: Option<Template>,
    pub tests: Vec<RuleTest>,
    /* private fields */
}
Expand description

One validated lint rule.

Fields§

§id: String

The rule’s unique id — what shows up as the diagnostic’s code, and what suppressions (a future feature) will name. Unique across all global rules and every scope’s rules.

§pattern: String

The pattern, as written in the config. Empty when the rule uses a parser instead.

§severity: Severity

How serious a hit is (default: Severity::Warning).

§message: Option<Template>

The message template, parsed and capture-validated. Optional when the rule has a callback (then it doubles as the message for callbacks that return “violate with the default message”).

§callback: Option<CallbackRef>

The rule’s callback reference, if any.

§parser: Option<CallbackRef>

The rule’s parser reference, if any — mutually exclusive with Rule::pattern.

§fix: Option<Template>

The fix template, if any: replaces each match, with captures interpolated like messages. Surfaces as a quickfix in editors and as declint check --fix.

§tests: Vec<RuleTest>

Embedded fixtures, run by declint test. Unused by the lint engine itself.

Trait Implementations§

Source§

impl Clone for Rule

Source§

fn clone(&self) -> Self

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 Rule

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Rule

§

impl RefUnwindSafe for Rule

§

impl Send for Rule

§

impl Sync for Rule

§

impl Unpin for Rule

§

impl UnsafeUnpin for Rule

§

impl UnwindSafe for Rule

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.