Struct tree_sitter_highlight::HighlightConfiguration [−][src]
Contains the data neeeded to higlight code written in a particular language.
This struct is immutable and can be shared between threads.
Fields
language: Language
query: Query
Implementations
impl HighlightConfiguration
[src]
pub fn new(
language: Language,
highlights_query: &str,
injection_query: &str,
locals_query: &str
) -> Result<Self, QueryError>
[src]
language: Language,
highlights_query: &str,
injection_query: &str,
locals_query: &str
) -> Result<Self, QueryError>
Creates a HighlightConfiguration
for a given Language
and set of highlighting
queries.
Parameters
language
- The Tree-sitterLanguage
that should be used for parsing.highlights_query
- A string containing tree patterns for syntax highlighting. This should be non-empty, otherwise no syntax highlights will be added.injections_query
- A string containing tree patterns for injecting other languages into the document. This can be empty if no injections are desired.locals_query
- A string containing tree patterns for tracking local variable definitions and references. This can be empty if local variable tracking is not needed.
Returns a HighlightConfiguration
that can then be used with the highlight
method.
pub fn names(&self) -> &[String]
[src]
Get a slice containing all of the highlight names used in the configuration.
pub fn configure(&mut self, recognized_names: &[String])
[src]
Set the list of recognized highlight names.
Tree-sitter syntax-highlighting queries specify highlights in the form of dot-separated
highlight names like punctuation.bracket
and function.method.builtin
. Consumers of
these queries can choose to recognize highlights with different levels of specificity.
For example, the string function.builtin
will match against function.method.builtin
and function.builtin.constructor
, but will not match function.method
.
When highlighting, results are returned as Highlight
values, which contain the index
of the matched highlight this list of highlight names.
Auto Trait Implementations
impl RefUnwindSafe for HighlightConfiguration
impl Send for HighlightConfiguration
impl Sync for HighlightConfiguration
impl Unpin for HighlightConfiguration
impl UnwindSafe for HighlightConfiguration
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,