Struct SyntaxHighlighter 

pub struct SyntaxHighlighter {
    pub theme_name: String,
    pub syntax_name: String,
    /* private fields */
}

Fields

theme_name: String

syntax_name: String

Implementations

impl SyntaxHighlighter

pub fn new() -> Self

pub fn for_path(path: &Path) -> Self

pub fn plain() -> Self

pub fn with_theme(self, theme_name: &str) -> Self

pub fn with_syntax(self, syntax_name: &str) -> Self

pub fn snapshot_state(&self) -> HighlighterState

Extract a HighlighterState snapshot of the highlighter’s configuration and accumulated checkpoints.

IMPORTANT: This snapshot contains ParseState / HighlightState values from syntect which are not guaranteed to be thread-safe. Do NOT send the resulting HighlighterState across threads. For background-workers use the theme/syntax names and the buffer lines to reconstruct a SyntaxHighlighter inside the worker (see app.rs worker changes).

pub fn from_state(state: HighlighterState) -> Self

Reconstruct a SyntaxHighlighter from a previously snapshotted state.

The resulting highlighter has an empty per-line cache but inherits all accumulated checkpoints, so highlighting resumes cheaply.

pub fn clear_cache(&self)

pub fn invalidate_from(&self, from_line: usize)

pub fn highlight_line_at( &self, lines: &[String], line: usize, version: Version, ) -> Arc<Vec<Token>>

pub fn highlight_range( &self, all_lines: &[String], version: Version, start_row: usize, count: usize, ) -> Vec<Vec<StyledSpan>>

pub fn highlight_tokens( &self, all_lines: &[String], version: Version, start_line: usize, count: usize, ) -> Vec<Arc<Vec<Token>>>

pub fn highlight_tokens_cancellable( &self, all_lines: &[String], version: Version, start_line: usize, count: usize, cancelled: &AtomicBool, ) -> Vec<Arc<Vec<Token>>>

Cancellable variant of highlight_tokens that checks cancelled between lines and returns early if cancellation is requested. Useful for aborting long-running background highlight tasks.

pub fn tokens_to_spans(&self, _line: &str, tokens: &[Token]) -> Vec<StyledSpan>

Trait Implementations

impl Clone for SyntaxHighlighter

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxHighlighter

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

Formats the value using the given formatter.

impl Default for SyntaxHighlighter

fn default() -> Self

Returns the “default value” for a type.