Struct tree_sitter::Query
source · [−]pub struct Query { /* private fields */ }
Expand description
A set of patterns that match nodes in a syntax tree.
Implementations
Create a new query from a string containing one or more S-expression patterns.
The query is associated with a particular language, and can only be run on syntax nodes parsed with that language. References to Queries can be shared between multiple threads.
Get the byte offset where the given pattern starts in the query’s source.
Get the number of patterns in the query.
Get the names of the captures used in the query.
Get the quantifiers of the captures used in the query.
Get the index for a given capture name.
Get the properties that are checked for the given pattern index.
This includes predicates with the operators is?
and is-not?
.
Get the properties that are set for the given pattern index.
This includes predicates with the operator set!
.
Get the other user-defined predicates associated with the given index.
This includes predicate with operators other than:
match?
eq?
andnot-eq?
is?
andis-not?
set!
Disable a certain capture within a query.
This prevents the capture from being returned in matches, and also avoids any resource usage associated with recording the capture.
Disable a certain pattern within a query.
This prevents the pattern from matching, and also avoids any resource usage associated with the pattern.
Check if a given step in a query is ‘definite’.
A query step is ‘definite’ if its parent pattern will be guaranteed to match successfully once it reaches the step.