Struct Query

pub struct Query { /* private fields */ }

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

Implementations

impl Query

pub unsafe fn from_raw( ptr: *mut TSQuery, source: &str, ) -> Result<Self, QueryError>

Reconstructs a Query from a raw pointer.

Safety

ptr must be non-null.

pub fn into_raw(self) -> *mut TSQuery

Consumes the Query, returning a raw pointer to the underlying C structure.

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. References to Queries can be shared between multiple threads.

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 end_byte_for_pattern(&self, pattern_index: usize) -> usize

Get the byte offset where the given pattern ends in the query’s source.

pub fn pattern_count(&self) -> usize

Get the number of patterns in the query.

pub const fn capture_names(&self) -> &[&str]

Get the names of the captures used in the query.

pub const fn capture_quantifiers(&self, index: usize) -> &[CaptureQuantifier]

Get the quantifiers of the captures used in the query.

pub fn capture_index_for_name(&self, name: &str) -> Option<u32>

Get the index for a given capture name.

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

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

This includes predicates with the operators is? and is-not?.

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

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

This includes predicates with the operator set!.

pub const fn general_predicates(&self, index: usize) -> &[QueryPredicate]

Get the other user-defined predicates associated with the given index.

This includes predicate with operators other than:

• match?
• eq? and not-eq?
• is? and is-not?
• set!

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.

pub fn disable_pattern(&mut self, index: usize)

Disable a certain pattern within a query.

This prevents the pattern from matching, and also avoids any resource usage associated with the pattern.

pub fn is_pattern_rooted(&self, index: usize) -> bool

Check if a given pattern within a query has a single root node.

pub fn is_pattern_non_local(&self, index: usize) -> bool

Check if a given pattern within a query has a single root node.

pub fn is_pattern_guaranteed_at_step(&self, byte_offset: usize) -> bool

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.

Trait Implementations

impl Debug for Query

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

Formats the value using the given formatter.

impl Drop for Query

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for Query

fn eq(&self, other: &Self) -> 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 Send for Query

impl Sync for Query