Struct SequenceExpr

pub struct SequenceExpr { /* private fields */ }

Implementations

impl SequenceExpr

pub fn then(self, expr: impl Expr + 'static) -> Self

Push an expression to the operation list.

pub fn then_optional(self, expr: impl Expr + 'static) -> Self

Pushes an expression that could move the cursor to the sequence, but does not require it.

pub fn then_seq(self, other: Self) -> Self

Appends the steps in other onto the end of self. This is more efficient than Self::then because it avoids pointer redirection.

pub fn then_indefinite_article(self) -> Self

Push an IndefiniteArticle to the end of the operation list.

pub fn then_exact_word(self, word: &'static str) -> Self

Match examples of word case-sensitively.

pub fn aco(word: &'static str) -> Self

Shorthand for Self::any_capitalization_of.

pub fn any_capitalization_of(word: &'static str) -> Self

Construct a new sequence with a Word at the beginning of the operation list.

pub fn t_aco(self, word: &'static str) -> Self

Shorthand for Self::then_any_capitalization_of.

pub fn then_any_capitalization_of(self, word: &'static str) -> Self

Match examples of word that have any capitalization.

pub fn then_any_word(self) -> Self

Matches any word.

pub fn then_strict(self, kind: TokenKind) -> Self

Matches any token whose Kind exactly matches.

pub fn t_ws(self) -> Self

Shorthand for Self::then_whitespace.

pub fn then_whitespace(self) -> Self

Match against one or more whitespace tokens.

pub fn then_one_or_more(self, expr: impl Expr + 'static) -> Self

pub fn then_unless(self, condition: impl Expr + 'static) -> Self

Create a new condition that will step one token forward if met. If the condition is not met, the whole expression returns None.

This can be used to build out exceptions to other rules.

See UnlessStep for more info.

pub fn t_any(self) -> Self

Match any single token.

Shorthand for Self::then_anything.

pub fn then_anything(self) -> Self

Match any single token.

See AnyPattern for more info.

pub fn then_nominal(self) -> Self

Adds a step matching a token where TokenKind::is_nominal() returns true.

pub fn then_one_or_more_nominals(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_nominal() returns true.

pub fn then_anything_but_nominal(self) -> Self

Adds a step matching a token where TokenKind::is_nominal() returns false.

pub fn then_noun(self) -> Self

Adds a step matching a token where TokenKind::is_noun() returns true.

pub fn then_one_or_more_nouns(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_noun() returns true.

pub fn then_anything_but_noun(self) -> Self

Adds a step matching a token where TokenKind::is_noun() returns false.

pub fn then_possessive_nominal(self) -> Self

Adds a step matching a token where TokenKind::is_possessive_nominal() returns true.

pub fn then_one_or_more_possessive_nominals(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_possessive_nominal() returns true.

pub fn then_anything_but_possessive_nominal(self) -> Self

Adds a step matching a token where TokenKind::is_possessive_nominal() returns false.

pub fn then_plural_nominal(self) -> Self

Adds a step matching a token where TokenKind::is_plural_nominal() returns true.

pub fn then_one_or_more_plural_nominals(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_plural_nominal() returns true.

pub fn then_anything_but_plural_nominal(self) -> Self

Adds a step matching a token where TokenKind::is_plural_nominal() returns false.

pub fn then_verb(self) -> Self

Adds a step matching a token where TokenKind::is_verb() returns true.

pub fn then_one_or_more_verbs(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_verb() returns true.

pub fn then_anything_but_verb(self) -> Self

Adds a step matching a token where TokenKind::is_verb() returns false.

pub fn then_auxiliary_verb(self) -> Self

Adds a step matching a token where TokenKind::is_auxiliary_verb() returns true.

pub fn then_one_or_more_auxiliary_verbs(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_auxiliary_verb() returns true.

pub fn then_anything_but_auxiliary_verb(self) -> Self

Adds a step matching a token where TokenKind::is_auxiliary_verb() returns false.

pub fn then_linking_verb(self) -> Self

Adds a step matching a token where TokenKind::is_linking_verb() returns true.

pub fn then_one_or_more_linking_verbs(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_linking_verb() returns true.

pub fn then_anything_but_linking_verb(self) -> Self

Adds a step matching a token where TokenKind::is_linking_verb() returns false.

pub fn then_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_pronoun() returns true.

pub fn then_one_or_more_pronouns(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_pronoun() returns true.

pub fn then_anything_but_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_pronoun() returns false.

pub fn then_punctuation(self) -> Self

Adds a step matching a token where TokenKind::is_punctuation() returns true.

pub fn then_one_or_more_punctuations(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_punctuation() returns true.

pub fn then_anything_but_punctuation(self) -> Self

Adds a step matching a token where TokenKind::is_punctuation() returns false.

pub fn then_conjunction(self) -> Self

Adds a step matching a token where TokenKind::is_conjunction() returns true.

pub fn then_one_or_more_conjunctions(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_conjunction() returns true.

pub fn then_anything_but_conjunction(self) -> Self

Adds a step matching a token where TokenKind::is_conjunction() returns false.

pub fn then_comma(self) -> Self

Adds a step matching a token where TokenKind::is_comma() returns true.

pub fn then_one_or_more_commas(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_comma() returns true.

pub fn then_anything_but_comma(self) -> Self

Adds a step matching a token where TokenKind::is_comma() returns false.

pub fn then_period(self) -> Self

Adds a step matching a token where TokenKind::is_period() returns true.

pub fn then_one_or_more_periods(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_period() returns true.

pub fn then_anything_but_period(self) -> Self

Adds a step matching a token where TokenKind::is_period() returns false.

pub fn then_number(self) -> Self

Adds a step matching a token where TokenKind::is_number() returns true.

pub fn then_one_or_more_numbers(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_number() returns true.

pub fn then_anything_but_number(self) -> Self

Adds a step matching a token where TokenKind::is_number() returns false.

pub fn then_case_separator(self) -> Self

Adds a step matching a token where TokenKind::is_case_separator() returns true.

pub fn then_one_or_more_case_separators(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_case_separator() returns true.

pub fn then_anything_but_case_separator(self) -> Self

Adds a step matching a token where TokenKind::is_case_separator() returns false.

pub fn then_adverb(self) -> Self

Adds a step matching a token where TokenKind::is_adverb() returns true.

pub fn then_one_or_more_adverbs(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_adverb() returns true.

pub fn then_anything_but_adverb(self) -> Self

Adds a step matching a token where TokenKind::is_adverb() returns false.

pub fn then_adjective(self) -> Self

Adds a step matching a token where TokenKind::is_adjective() returns true.

pub fn then_one_or_more_adjectives(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_adjective() returns true.

pub fn then_anything_but_adjective(self) -> Self

Adds a step matching a token where TokenKind::is_adjective() returns false.

pub fn then_apostrophe(self) -> Self

Adds a step matching a token where TokenKind::is_apostrophe() returns true.

pub fn then_one_or_more_apostrophes(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_apostrophe() returns true.

pub fn then_anything_but_apostrophe(self) -> Self

Adds a step matching a token where TokenKind::is_apostrophe() returns false.

pub fn then_hyphen(self) -> Self

Adds a step matching a token where TokenKind::is_hyphen() returns true.

pub fn then_one_or_more_hyphens(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_hyphen() returns true.

pub fn then_anything_but_hyphen(self) -> Self

Adds a step matching a token where TokenKind::is_hyphen() returns false.

pub fn then_determiner(self) -> Self

Adds a step matching a token where TokenKind::is_determiner() returns true.

pub fn then_one_or_more_determiners(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_determiner() returns true.

pub fn then_anything_but_determiner(self) -> Self

Adds a step matching a token where TokenKind::is_determiner() returns false.

pub fn then_proper_noun(self) -> Self

Adds a step matching a token where TokenKind::is_proper_noun() returns true.

pub fn then_one_or_more_proper_nouns(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_proper_noun() returns true.

pub fn then_anything_but_proper_noun(self) -> Self

Adds a step matching a token where TokenKind::is_proper_noun() returns false.

pub fn then_preposition(self) -> Self

Adds a step matching a token where TokenKind::is_preposition() returns true.

pub fn then_one_or_more_prepositions(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_preposition() returns true.

pub fn then_anything_but_preposition(self) -> Self

Adds a step matching a token where TokenKind::is_preposition() returns false.

pub fn then_third_person_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_third_person_pronoun() returns true.

pub fn then_one_or_more_third_person_pronouns(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_third_person_pronoun() returns true.

pub fn then_anything_but_third_person_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_third_person_pronoun() returns false.

pub fn then_third_person_singular_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_third_person_singular_pronoun() returns true.

pub fn then_one_or_more_third_person_singular_pronouns(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_third_person_singular_pronoun() returns true.

pub fn then_anything_but_third_person_singular_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_third_person_singular_pronoun() returns false.

pub fn then_third_person_plural_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_third_person_plural_pronoun() returns true.

pub fn then_one_or_more_third_person_plural_pronouns(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_third_person_plural_pronoun() returns true.

pub fn then_anything_but_third_person_plural_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_third_person_plural_pronoun() returns false.

pub fn then_first_person_singular_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_first_person_singular_pronoun() returns true.

pub fn then_one_or_more_first_person_singular_pronouns(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_first_person_singular_pronoun() returns true.

pub fn then_anything_but_first_person_singular_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_first_person_singular_pronoun() returns false.

pub fn then_first_person_plural_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_first_person_plural_pronoun() returns true.

pub fn then_one_or_more_first_person_plural_pronouns(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_first_person_plural_pronoun() returns true.

pub fn then_anything_but_first_person_plural_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_first_person_plural_pronoun() returns false.

pub fn then_second_person_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_second_person_pronoun() returns true.

pub fn then_one_or_more_second_person_pronouns(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_second_person_pronoun() returns true.

pub fn then_anything_but_second_person_pronoun(self) -> Self

Adds a step matching a token where TokenKind::is_second_person_pronoun() returns false.

pub fn then_non_plural_nominal(self) -> Self

Adds a step matching a token where TokenKind::is_non_plural_nominal() returns true.

pub fn then_one_or_more_non_plural_nominals(self) -> Self

Adds a step matching one or more consecutive tokens where TokenKind::is_non_plural_nominal() returns true.

pub fn then_anything_but_non_plural_nominal(self) -> Self

Adds a step matching a token where TokenKind::is_non_plural_nominal() returns false.

Trait Implementations

impl Default for SequenceExpr

fn default() -> SequenceExpr

Returns the “default value” for a type.

impl Expr for SequenceExpr

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

Run the expression starting at an index, returning the total matched window.

If any step returns None, the entire expression does as well.

impl<S> From<S> for SequenceExpr

where S: Step + 'static,

fn from(step: S) -> Self

Converts to this type from the input type.