Struct QueryCursor

pub struct QueryCursor { /* private fields */ }

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

Implementations

impl QueryCursor

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

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 set_timeout_micros(&mut self, timeout: u64)

👎Deprecated since 0.25.0: Prefer using matches_with_options or captures_with_options and using a callback

Set the maximum duration in microseconds that query execution should be allowed to take before halting.

If query execution takes longer than this, it will halt early, returning None.

pub fn timeout_micros(&self) -> u64

👎Deprecated since 0.25.0: Prefer using matches_with_options or captures_with_options and using a callback

Get the duration in microseconds that query execution is allowed to take.

This is set via set_timeout_micros.

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<'query, 'cursor: 'query, 'tree, T: TextProvider<I>, I: AsRef<[u8]>>( &'cursor mut self, query: &'query Query, node: Node<'tree>, text_provider: T, ) -> QueryMatches<'query, 'tree, T, I>

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.

Iterating over a QueryMatches object requires the StreamingIterator or StreamingIteratorMut trait to be in scope. This can be done via use tree_sitter::StreamingIterator or use tree_sitter::StreamingIteratorMut

pub fn matches_with_options<'query, 'cursor: 'query, 'tree, T: TextProvider<I>, I: AsRef<[u8]>>( &'cursor mut self, query: &'query Query, node: Node<'tree>, text_provider: T, options: QueryCursorOptions<'_>, ) -> QueryMatches<'query, 'tree, T, I>

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

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<'query, 'cursor: 'query, 'tree, T: TextProvider<I>, I: AsRef<[u8]>>( &'cursor mut self, query: &'query Query, node: Node<'tree>, text_provider: T, ) -> QueryCaptures<'query, 'tree, T, I>

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.

Iterating over a QueryCaptures object requires the StreamingIterator or StreamingIteratorMut trait to be in scope. This can be done via use tree_sitter::StreamingIterator or use tree_sitter::StreamingIteratorMut

pub fn captures_with_options<'query, 'cursor: 'query, 'tree, T: TextProvider<I>, I: AsRef<[u8]>>( &'cursor mut self, query: &'query Query, node: Node<'tree>, text_provider: T, options: QueryCursorOptions<'_>, ) -> QueryCaptures<'query, 'tree, T, I>

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

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.

pub fn set_max_start_depth(&mut self, max_start_depth: Option<u32>) -> &mut Self

Set the maximum start depth for a query cursor.

This prevents cursors from exploring children nodes at a certain depth. Note if a pattern includes many children, then they will still be checked.

The zero max start depth value can be used as a special behavior and it helps to destructure a subtree by staying on a node and using captures for interested parts. Note that the zero max start depth only limit a search depth for a pattern’s root node but other nodes that are parts of the pattern may be searched at any depth what defined by the pattern structure.

Set to None to remove the maximum start depth.

Trait Implementations

impl Default for QueryCursor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for QueryCursor

fn drop(&mut self)

Executes the destructor for this type.

impl Send for QueryCursor

impl Sync for QueryCursor