Struct SyntaxHighlighter 

pub struct SyntaxHighlighter { /* private fields */ }

A grammar-backed Highlighter for one language.

As a Highlighter, a pass starts at carry 0 and each line’s carry is only meaningful to the line after it within that pass: carries index the parse states recorded since the last carry-0 call. Callers keeping their own caches use SyntaxHighlighter::start and SyntaxState directly.

Implementations

impl SyntaxHighlighter

pub fn for_token(token: &str) -> Option<SyntaxHighlighter>

Look a grammar up by file extension (rs, toml) or by case-insensitive name (Rust, Dockerfile), the way a Markdown fence tag names its language. None when no grammar matches.

pub fn plain_text() -> SyntaxHighlighter

Plain text: every line is a single TokenKind::Text run.

pub fn for_token_or_plain(token: &str) -> SyntaxHighlighter

SyntaxHighlighter::for_token, falling back to plain text.

pub fn name(&self) -> &'static str

The grammar’s display name (Rust, Plain Text).

pub fn start(&self) -> SyntaxState

The parse state at the start of a document.

Trait Implementations

impl Highlighter for SyntaxHighlighter

fn spans(&self, line: &str, carry: u64) -> LineSpans

line never contains \n. carry is the HlState the previous line left (0 for the first line); the returned LineSpans::carry is what the following line begins with. Byte ranges in the returned spans are relative to line.