Struct harper_core::Document

pub struct Document { /* private fields */ }

Implementations

impl Document

pub fn new(text: &str, parser: Box<dyn Parser>) -> Self

Lexes and parses text to produce a document. Choosing to parse with markdown may have a performance penalty

pub fn new_from_vec(source: Vec<char>, parser: Box<dyn Parser>) -> Self

pub fn new_plain_english(text: &str) -> Self

pub fn new_markdown(text: &str) -> Self

pub fn get_token_at_char_index(&self, char_index: usize) -> Option<Token>

pub fn get_token(&self, index: usize) -> Option<Token>

Defensively attempt to grab a specific token.

pub fn tokens(&self) -> impl Iterator<Item = Token> + '_

pub fn fat_tokens(&self) -> impl Iterator<Item = FatToken> + '_

pub fn sentences(&self) -> impl Iterator<Item = &[Token]> + '_

pub fn words(&self) -> impl Iterator<Item = Token> + '_

Returns all tokens whose kind is TokenKind::Word

pub fn get_span_content(&self, span: Span) -> &[char]

pub fn get_span_content_str(&self, span: Span) -> String

pub fn get_full_string(&self) -> String

pub fn get_full_content(&self) -> &[char]

pub fn apply_suggestion(&mut self, suggestion: &Suggestion, span: Span)

Trait Implementations

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl Display for Document

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TokenStringExt for Document

fn first_word(&self) -> Option<Token>

fn first_sentence_word(&self) -> Option<Token>

Grabs the first word in the sentence. Will also return None if there is an unlintable token in the position of the first word.

fn first_non_whitespace(&self) -> Option<Token>

Grabs the first token that isn’t whitespace from the token string.

fn iter_word_indices(&self) -> impl Iterator<Item = usize> + '_

fn iter_words(&self) -> impl Iterator<Item = &Token> + '_

fn iter_space_indices(&self) -> impl Iterator<Item = usize> + '_

fn iter_spaces(&self) -> impl Iterator<Item = &Token> + '_

fn iter_apostrophe_indices(&self) -> impl Iterator<Item = usize> + '_

fn iter_apostrophes(&self) -> impl Iterator<Item = &Token> + '_

fn span(&self) -> Option<Span>

Grab the span that represents the beginning of the first element and the end of the last element.

fn iter_quote_indices(&self) -> impl Iterator<Item = usize> + '_

fn iter_quotes(&self) -> impl Iterator<Item = Token> + '_

fn iter_number_indices(&self) -> impl Iterator<Item = usize> + '_

fn iter_numbers(&self) -> impl Iterator<Item = Token> + '_