harper_core::linting

Struct Proofread

Source 
pub struct Proofread { /* private fields */ }

Trait Implementations§

Source§

impl Default for Proofread

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PatternLinter for Proofread

Source§

fn pattern(&self) -> &dyn Pattern

A simple getter for the pattern to be searched for.
Source§

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

If any portions of a Document match Self::pattern, they are passed through PatternLinter::match_to_lint to be transformed into a Lint for editor consumption.
Source§

fn description(&self) -> &'static str

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

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<L> Linter for L
where L: PatternLinter,

Source§

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

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

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.
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.