Struct RuleSet 

pub struct RuleSet { /* private fields */ }

An ordered, name-unique collection of LintRules.

Implementations

impl RuleSet

pub fn new() -> Self

An empty set; add rules with Self::add.

pub fn stdlib_defaults() -> Self

The stdlib’s curated default-on rules. Equivalent to crate::stdlib::defaults.

pub fn stdlib_all() -> Self

Every stdlib rule, including the default-off ones. Equivalent to crate::stdlib::all.

pub fn add( &mut self, rule: Box<dyn LintRule>, ) -> Result<&mut Self, DuplicateRuleName>

Insert a rule. Names must be unique within the set.

Errors

Returns DuplicateRuleName if a rule with the same name() is already present.

pub fn remove(&mut self, name: &str) -> bool

Remove the rule with the given name. Returns true if a rule was removed, false if no rule had that name.

pub fn contains(&self, name: &str) -> bool

pub fn iter(&self) -> impl Iterator<Item = &dyn LintRule>

pub fn by_name(&self, name: &str) -> Option<&dyn LintRule>

Look up a rule by its name.

pub fn names(&self) -> impl Iterator<Item = &str>

Iterate over the names of every rule in the set.

pub fn check(&self, doc: &Document) -> Vec<Diagnostic>

Run every rule in the set over doc.

pub fn check_with(&self, doc: &Document, opts: LintOptions) -> Vec<Diagnostic>

Run every rule in the set over doc under opts.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl Debug for RuleSet

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

Formats the value using the given formatter.

impl Default for RuleSet

fn default() -> RuleSet

Returns the “default value” for a type.

impl IntoIterator for RuleSet

Consumes the set and yields its rules in insertion order.

Required by the CLI’s --rules selector, which partitions the available pool of rules into the user-requested subset without cloning trait objects (LintRule is not Clone).

type Item = Box<dyn LintRule>

The type of the elements being iterated over.

type IntoIter = IntoIter<Box<dyn LintRule>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.