arborium 2.16.0

Tree-sitter syntax highlighting with HTML rendering and WASM support
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

//! Unified error type for arborium.

use std::fmt;
use std::io;

/// Error type for highlighting operations.
///
/// This is marked `#[non_exhaustive]` to allow adding new variants
/// in future versions without breaking changes.
#[derive(Debug)]
#[non_exhaustive]
pub enum Error {
    /// The requested language is not supported.
    ///
    /// This occurs when no grammar is available for the given language name.
    /// Language availability depends on which `lang-*` features are enabled.
    UnsupportedLanguage {
        /// The language that was requested.
        language: String,
    },

    /// An error occurred while parsing the source code.
    ///
    /// This typically indicates a problem with the grammar or an internal
    /// tree-sitter error.
    ParseError {
        /// The language being parsed.
        language: String,
        /// A description of what went wrong.
        message: String,
    },

    /// An error occurred while compiling a tree-sitter query.
    ///
    /// This indicates a problem with the grammar's highlight or injection queries.
    QueryError {
        /// The language whose query failed.
        language: String,
        /// A description of the query error.
        message: String,
    },

    /// An I/O error occurred during highlighting.
    ///
    /// This typically happens when writing to a `Write` destination fails.
    Io(io::Error),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::UnsupportedLanguage { language } => {
                write!(f, "unsupported language: {}", language)
            }
            Error::ParseError { language, message } => {
                write!(f, "parse error for {}: {}", language, message)
            }
            Error::QueryError { language, message } => {
                write!(f, "query error for {}: {}", language, message)
            }
            Error::Io(e) => write!(f, "I/O error: {}", e),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Error::Io(e) => Some(e),
            _ => None,
        }
    }
}

impl From<io::Error> for Error {
    fn from(e: io::Error) -> Self {
        Error::Io(e)
    }
}

/// Convert from the internal arborium-highlight error type.
impl From<arborium_highlight::HighlightError> for Error {
    fn from(e: arborium_highlight::HighlightError) -> Self {
        match e {
            arborium_highlight::HighlightError::UnsupportedLanguage(language) => {
                Error::UnsupportedLanguage { language }
            }
            arborium_highlight::HighlightError::ParseError(message) => Error::ParseError {
                language: String::new(), // We don't have the language here
                message,
            },
        }
    }
}