Enum HighlightEngine 

pub enum HighlightEngine {
    TreeSitter(Box<Highlighter>),
    TextMate(Box<TextMateEngine>),
    None,
}

Unified highlighting engine supporting multiple backends

Variants

TreeSitter(Box<Highlighter>)

Tree-sitter based highlighting (built-in languages)

TextMate(Box<TextMateEngine>)

TextMate grammar based highlighting

None

No highlighting available

Implementations

impl HighlightEngine

pub fn from_entry(entry: &GrammarEntry, registry: &GrammarRegistry) -> Self

Build a highlighting engine for a catalog entry.

Single chokepoint for the “prefer syntect, fall back to tree-sitter” logic. Callers that start from a path or a syntax name should resolve the entry through GrammarRegistry::find_by_path / find_by_name and then call this.

pub fn for_file( path: &Path, first_line: Option<&str>, registry: &GrammarRegistry, ) -> Self

Create a highlighting engine for a file.

Thin wrapper around from_entry that resolves the path via the catalog. User-config-declared filename/extension mappings are honoured as long as GrammarRegistry::apply_language_config has been called on the registry. first_line is used for shebang / first-line regex fallback — pass None when no content is available.

pub fn for_syntax_name(name: &str, registry: &GrammarRegistry) -> Self

Create a highlighting engine for a syntax by name.

Thin wrapper around from_entry that performs the lookup via find_by_name. The catalog entry already knows which tree-sitter Language (if any) serves it, so no separate hint is needed.

pub fn highlight_viewport( &mut self, buffer: &Buffer, viewport_start: usize, viewport_end: usize, theme: &Theme, context_bytes: usize, ) -> Vec<HighlightSpan>

Highlight the visible viewport

context_bytes controls how far before/after the viewport to parse for accurate highlighting of multi-line constructs (strings, comments, nested blocks).

pub fn notify_insert(&mut self, position: usize, length: usize)

Notify the highlighting engine of a buffer insert (for checkpoint position tracking).

pub fn notify_delete(&mut self, position: usize, length: usize)

Notify the highlighting engine of a buffer delete (for checkpoint position tracking).

pub fn invalidate_range(&mut self, edit_range: Range<usize>)

Invalidate cache for an edited range

pub fn invalidate_all(&mut self)

Invalidate entire cache

pub fn has_highlighting(&self) -> bool

Check if this engine has highlighting available

pub fn backend_name(&self) -> &str

Get a description of the active backend

pub fn highlight_stats(&self) -> Option<&HighlightStats>

Get performance stats (TextMate engine only).

pub fn reset_highlight_stats(&mut self)

Reset performance counters.

pub fn syntax_name(&self) -> Option<&str>

Get the language/syntax name if available

pub fn category_at_position(&self, position: usize) -> Option<HighlightCategory>

Get the highlight category at a byte position from the cache.

Returns the category if the position falls within a cached highlight span. Useful for detecting whether the cursor is inside a string, comment, etc.

pub fn language(&self) -> Option<&Language>

Get the tree-sitter Language for non-highlighting features Returns the language even when using TextMate for highlighting

Trait Implementations

impl Default for HighlightEngine

fn default() -> HighlightEngine

Returns the “default value” for a type.