Struct MapPhraseLinter 

pub struct MapPhraseLinter { /* private fields */ }

Implementations

impl MapPhraseLinter

pub fn new( expr: Box<dyn Expr>, correct_forms: impl IntoIterator<Item = impl ToString>, message: impl ToString, description: impl ToString, lint_kind: Option<LintKind>, ) -> Self

pub fn new_similar_to_phrase( phrase: &'static str, detectable_distance: u8, ) -> Self

pub fn new_fixed_phrases( phrase: impl IntoIterator<Item = impl AsRef<str>>, correct_forms: impl IntoIterator<Item = impl ToString>, message: impl ToString, description: impl ToString, lint_kind: Option<LintKind>, ) -> Self

pub fn new_fixed_phrase( phrase: impl AsRef<str>, correct_forms: impl IntoIterator<Item = impl ToString>, message: impl ToString, description: impl ToString, lint_kind: Option<LintKind>, ) -> Self

pub fn new_closed_compound( phrase: impl AsRef<str>, correct_form: impl ToString, ) -> Self

Trait Implementations

impl ExprLinter for MapPhraseLinter

type Unit = Chunk

fn expr(&self) -> &dyn Expr

A simple getter for the expression you want Harper to search for.

fn match_to_lint( &self, matched_tokens: &[Token], source: &[char], ) -> Option<Lint>

If any portions of a Document match Self::expr, they are passed through ExprLinter::match_to_lint or ExprLinter::match_to_lint_with_context to be transformed into a Lint for editor consumption.

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.

fn match_to_lint_with_context( &self, matched_tokens: &[Token], source: &[char], _context: Option<(&[Token], &[Token])>, ) -> Option<Lint>

Transform matched tokens into a Lint with access to surrounding context.