Struct tree_sitter::Query

pub struct Query { /* fields omitted */ }

A set of patterns that match nodes in a syntax tree.

Methods

impl Query

pub fn new(language: Language, source: &str) -> Result<Self, QueryError>

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.

pub fn start_byte_for_pattern(&self, pattern_index: usize) -> usize

Get the byte offset where the given pattern starts in the query's source.

pub fn pattern_count(&self) -> usize

Get the number of patterns in the query.

pub fn capture_names(&self) -> &[String]

Get the names of the captures used in the query.

pub fn property_predicates(&self, index: usize) -> &[(QueryProperty, bool)]

Get the properties that are checked for the given pattern index.

pub fn property_settings(&self, index: usize) -> &[QueryProperty]

Get the properties that are set for the given pattern index.

pub fn disable_capture(&mut self, name: &str)

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.

Trait Implementations

impl Send for Query

impl Sync for Query

impl Drop for Query

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq<Query> for Query

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Query

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

Formats the value using the given formatter.