Enum HighlightError 

#[non_exhaustive]
pub enum HighlightError {
    GrammarLoad {
        language: Language,
        message: String,
    },
    Query {
        language: Language,
        row: usize,
        column: usize,
        offset: usize,
        kind: HighlightQueryErrorKind,
        message: String,
    },
    Parse {
        language: Language,
    },
    InvalidEdit {
        start_byte: usize,
        old_end_byte: usize,
        new_end_byte: usize,
        old_len: usize,
        new_len: usize,
    },
}

A typed error produced while preparing runtime syntax highlighting.

These errors are recoverable for renderers: callers can surface the error and render the original source as plaintext.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

GrammarLoad

The tree-sitter parser rejected the selected grammar.

Fields

language: Language

The language whose grammar failed to load.

message: String

The parser’s diagnostic message.

Query

The tree-sitter highlights query failed to compile.

Fields

language: Language

The language whose query failed.

row: usize

Zero-based query row where the error was reported.

column: usize

Zero-based query column where the error was reported.

offset: usize

Byte offset where the error was reported.

kind: HighlightQueryErrorKind

The query error kind.

message: String

The query compiler’s diagnostic message.

Parse

Tree-sitter failed to parse the source.

Fields

language: Language

The language being parsed.

InvalidEdit

Buffer::edit received offsets that are out of bounds or not on UTF-8 character boundaries.

The buffer’s state is unchanged when this error is returned.

Fields

start_byte: usize

First byte the caller said changed.

old_end_byte: usize

One past the last byte of the replaced region in the previous source.

new_end_byte: usize

One past the last byte of the inserted region in the new source.

old_len: usize

Length of the previous source, for context.

new_len: usize

Length of the new source, for context.

Trait Implementations

impl Clone for HighlightError

fn clone(&self) -> HighlightError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HighlightError

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

Formats the value using the given formatter.

impl Display for HighlightError

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

Formats the value using the given formatter.

impl Error for HighlightError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for HighlightError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HighlightError

impl StructuralPartialEq for HighlightError