Struct Dictionary 

pub struct Dictionary { /* private fields */ }

Manages a set of ignored words for filtering grammar errors.

Loads .docolint-ignore files hierarchically from the document’s directory up to the workspace root. Words are stored case-insensitively (lowercased). Supports adding new words to a target ignore file and filtering errors based on ignored words.

Implementations

impl Dictionary

pub fn new() -> Self

Creates an empty dictionary with no ignored words.

pub fn load(workspace_root: &Path, document_path: &Path) -> Self

Loads and merges .docolint-ignore files from document_path up to workspace_root.

Walks the directory tree upward, reading each .docolint-ignore file found. Lines starting with # are treated as comments and skipped. Empty lines are ignored. Words are lowercased before storage.

Arguments

• workspace_root - The root directory to stop walking at. Must be an ancestor of (or equal to) document_path’s parent.
• document_path - Path to the source file being checked. If this is a file, its parent directory is used as the starting point.

Panics

Does not panic. File read errors are silently ignored (missing files = no words).

pub fn is_ignored(&self, word: &str) -> bool

Checks if a word is in the ignored set (case-insensitive).

Arguments

• word - The word to check. Compared in lowercase against stored words.

pub fn add_word(&mut self, word: &str, target_file: &Path) -> Result<()>

Appends a word to a .docolint-ignore file and adds it to the in-memory set.

Creates the file if it does not exist. The word is lowercased before writing. No duplicate check is performed on the file; duplicates are harmless since the in-memory set deduplicates automatically.

Arguments

• word - The word to ignore. Empty strings are silently ignored.
• target_file - Path to the .docolint-ignore file to append to.

Errors

Returns std::io::Error if the file cannot be opened or written.

pub fn filter_errors( &self, text: &str, errors: Vec<GrammarError>, ) -> Vec<GrammarError>

Filters out grammar errors whose matched word is in the ignored set.

Extracts the word from text using each error’s offset and length, then checks it against the ignored set. Errors with out-of-bounds offsets are kept (not filtered).

Arguments

• text - The plain text string that LanguageTool checked. Offsets in errors are relative to this string.
• errors - Grammar errors to filter. Consumed by this function.

Returns

A new Vec containing only errors whose matched word is not ignored.

Trait Implementations

impl Default for Dictionary

fn default() -> Self

Returns the “default value” for a type.