Struct Query 

pub struct Query { /* private fields */ }

Implementations

impl Query

pub fn new( grammar: Grammar, source: &str, custom_predicate: impl FnMut(Pattern, UserPredicate<'_>) -> Result<(), InvalidPredicateError>, ) -> Result<Self, ParseError>

Create a new query from a string containing one or more S-expression patterns.

The query is associated with a particular grammar, and can only be run on syntax nodes parsed with that grammar. References to Queries can be shared between multiple threads.

pub fn capture_name(&self, capture_idx: Capture) -> &str

pub fn captures(&self) -> impl ExactSizeIterator<Item = (Capture, &str)>

pub fn num_captures(&self) -> u32

pub fn get_capture(&self, capture_name: &str) -> Option<Capture>

pub fn start_byte_for_pattern(&self, pattern: Pattern) -> 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 patterns(&self) -> impl ExactSizeIterator<Item = Pattern>

Get the number of patterns in the query.

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. Currently, there is no way to undo this.

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 Send for Query

impl Sync for Query