Struct ExprMap

Source
pub struct ExprMap<T>
where T: LSend,
{ /* private fields */ }
Expand description

A map from an Expr to arbitrary data.

It has been a common pattern for rule authors to build a list of expressions that match a grammatical error. Then, depending on which expression was matched, a suggestion is chosen from another list.

The ExprMap unifies these two lists into one.

A great example of this is the PronounInfectionBe rule. It builds a list of incorrect PRONOUN + BE combinations, alongside their corrections.

When used as a Expr in and of itself, it simply iterates through all contained expressions, returning the first match found. You should not assume this search is deterministic.

Implementations§

Source§

impl<T> ExprMap<T>
where T: LSend,

Source

pub fn insert(&mut self, expr: impl Expr + 'static, value: T)

Source

pub fn lookup( &self, cursor: usize, tokens: &[Token], source: &[char], ) -> Option<&T>

Look up the corresponding value for the given map.

Trait Implementations§

Source§

impl<T> Default for ExprMap<T>
where T: LSend,

Source§

fn default() -> Self

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

impl<T> Expr for ExprMap<T>
where T: LSend,

Source§

fn run(&self, cursor: usize, tokens: &[Token], source: &[char]) -> Option<Span>

Auto Trait Implementations§

§

impl<T> Freeze for ExprMap<T>

§

impl<T> !RefUnwindSafe for ExprMap<T>

§

impl<T> !Send for ExprMap<T>

§

impl<T> !Sync for ExprMap<T>

§

impl<T> Unpin for ExprMap<T>
where T: Unpin,

§

impl<T> !UnwindSafe for ExprMap<T>

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<E> ExprExt for E
where E: Expr + ?Sized,

Source§

fn iter_matches<'a>( &'a self, tokens: &'a [Token], source: &'a [char], ) -> Box<dyn Iterator<Item = Span> + 'a>

Iterate over all matches of this expression in the document, automatically filtering out overlapping matches, preferring the first.
Source§

fn iter_matches_in_doc<'a>( &'a self, doc: &'a Document, ) -> Box<dyn Iterator<Item = Span> + 'a>

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<E> OwnedExprExt for E
where E: Expr + 'static,

Source§

fn or(self, other: impl Expr + 'static) -> LongestMatchOf

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

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> LSend for T
where T: ?Sized,