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_plain_english(text: &str) -> Self

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

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

pub fn iter_quotes(&self) -> impl Iterator<Item = 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 [Punctuation::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 Display for Document

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

Formats the value using the given formatter.