Struct LintGroup

pub struct LintGroup {
    pub config: LintGroupConfig,
    /* private fields */
}

Fields

config: LintGroupConfig

Implementations

impl LintGroup

pub fn empty() -> Self

pub fn contains_key(&self, name: impl AsRef<str>) -> bool

Check if the group already contains a linter with a given name.

pub fn add(&mut self, name: impl AsRef<str>, linter: Box<dyn Linter>) -> bool

Add a Linter to the group, returning whether the operation was successful. If it returns false, it is because a linter with that key already existed in the group.

pub fn add_pattern_linter( &mut self, name: impl AsRef<str>, linter: Box<dyn PatternLinter>, ) -> bool

Add a PatternLinter to the group, returning whether the operation was successful. If it returns false, it is because a linter with that key already existed in the group.

This function is not significantly different from Self::add, but allows us to take advantage of some properties of PatternLinters for cache optimization.

pub fn merge_from(&mut self, other: &mut LintGroup)

Merge the contents of another LintGroup into this one. The other lint group will be left empty after this operation.

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

pub fn set_all_rules_to(&mut self, enabled: Option<bool>)

Set all contained rules to a specific value. Passing None will unset that rule, allowing it to assume its default state.

pub fn all_descriptions(&self) -> HashMap<&str, &str>

pub fn with_lint_config(self, config: LintGroupConfig) -> Self

Swap out Self::config with another LintGroupConfig.

pub fn new_curated( dictionary: Arc<impl Dictionary + 'static>, dialect: Dialect, ) -> Self

pub fn new_curated_empty_config( dictionary: Arc<impl Dictionary + 'static>, dialect: Dialect, ) -> Self

Create a new curated group with all config values cleared out.

Trait Implementations

impl Default for LintGroup

fn default() -> Self

Returns the “default value” for a type.

impl Linter for LintGroup

fn lint(&mut self, document: &Document) -> Vec<Lint>

Analyzes a document and produces zero or more Lints. We pass self mutably for caching purposes.

fn description(&self) -> &str

A user-facing description of what kinds of grammatical errors this rule looks for. It is usually shown in settings menus.