Struct ProseRange 

pub struct ProseRange {
    pub start_byte: usize,
    pub end_byte: usize,
    pub exclusions: Vec<(usize, usize)>,
    pub language: Option<String>,
}

Fields

start_byte: usize

end_byte: usize

exclusions: Vec<(usize, usize)>

Byte ranges (document-level) within this prose range that should be excluded from grammar checking (e.g. display math). These regions are replaced with spaces when extracting text, preserving byte offsets.

language: Option<String>

The natural language this prose is written in, as a BCP-47 tag, when the document says so — a lang-check-begin lang: directive, or the format’s own declaration such as Typst’s #set text(lang: "fr"). None means the configured spell_language applies.

Implementations

impl ProseRange

pub fn extract_text<'a>(&self, text: &'a str) -> Cow<'a, str>

Extract the prose text from the full document, replacing any excluded regions with spaces so that byte offsets remain stable.

pub fn overlaps_exclusion(&self, local_start: u32, local_end: u32) -> bool

Check whether a local byte range (relative to this prose range) overlaps with any exclusion zone.

pub fn exclusion_adjacency( &self, text: &str, local_start: u32, local_end: u32, ) -> ExclusionAdjacency

Classify how a diagnostic (range-local byte span) sits relative to the skipped (excluded) segments in this range. Excluded segments are blanked to spaces before checking, which breaks the surrounding sentence and provokes false positives on the flanking text — this drives which of those to suppress (see Self::suppresses_diagnostic).

pub fn suppresses_diagnostic( &self, text: &str, local_start: u32, local_end: u32, unified_id: &str, ) -> bool

Whether a diagnostic should be dropped as a skip-induced false positive.

• Overlapping a skip, or glued to one with no character between them (blanking split a real word into a fragment): always suppressed.
• Separated from a skip by whitespace only (a real word flanking the cut): suppressed unless it is a spelling diagnostic. Removing a neighbour cannot misspell a real word, so genuine typos beside formulas are kept; the structural grammar/typography/style noise is dropped.
• Otherwise: kept.

pub fn adopt_diagnostics(&self, text: &str, diagnostics: &mut Vec<Diagnostic>)

Take ownership of an engine’s findings for this range: drop the skip-induced false positives, then rebase the survivors from range-local onto document byte offsets.

Trait Implementations

impl Clone for ProseRange

fn clone(&self) -> ProseRange

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProseRange

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

Formats the value using the given formatter.

impl Eq for ProseRange

impl PartialEq for ProseRange

fn eq(&self, other: &ProseRange) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ProseRange