Struct QueryCursor

pub struct QueryCursor { /* private fields */ }

A stateful object for executing a Query on a syntax Tree.

Implementations

impl QueryCursor

pub unsafe fn from_raw(ptr: *mut TSQueryCursor) -> QueryCursor

Reconstructs a QueryCursor from a raw pointer.

Safety

ptr must be non-null.

pub fn into_raw(self) -> *mut TSQueryCursor

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

impl QueryCursor

pub fn new() -> Self

Create a new cursor for executing a given query.

The cursor stores the state that is needed to iteratively search for matches.

pub fn match_limit(&self) -> u32

Return the maximum number of in-progress matches for this cursor.

pub fn set_match_limit(&mut self, limit: u32)

Set the maximum number of in-progress matches for this cursor. The limit must be > 0 and <= 65536.

pub fn did_exceed_match_limit(&self) -> bool

Check if, on its last execution, this cursor exceeded its maximum number of in-progress matches.

pub fn matches<'a, 'tree: 'a, T: TextProvider<'a> + 'a>( &'a mut self, query: &'a Query, node: Node<'tree>, text_provider: T, ) -> QueryMatches<'a, 'tree, T>

Iterate over all of the matches in the order that they were found.

Each match contains the index of the pattern that matched, and a list of captures. Because multiple patterns can match the same set of nodes, one match may contain captures that appear before some of the captures from a previous match.

pub fn captures<'a, 'tree: 'a, T: TextProvider<'a> + 'a>( &'a mut self, query: &'a Query, node: Node<'tree>, text_provider: T, ) -> QueryCaptures<'a, 'tree, T>

Iterate over all of the individual captures in the order that they appear.

This is useful if you don’t care about which pattern matched, and just want a single, ordered sequence of captures.

pub fn set_byte_range(&mut self, range: Range<usize>) -> &mut Self

Set the range in which the query will be executed, in terms of byte offsets.

pub fn set_point_range(&mut self, range: Range<Point>) -> &mut Self

Set the range in which the query will be executed, in terms of rows and columns.

Trait Implementations

impl Drop for QueryCursor

fn drop(&mut self)

Executes the destructor for this type.

impl Send for QueryCursor

impl Sync for QueryCursor