Struct yak_sitter::QueryMatch

pub struct QueryMatch<'query, 'tree, Custom = ()> { /* private fields */ }

Wrapper around tree_sitter::QueryMatch

Implementations

impl<'query, 'tree, Custom> QueryMatch<'query, 'tree, Custom>

pub fn iter_captures( &self ) -> impl Iterator<Item = QueryCapture<'query, 'tree, Custom>>

Iterate all captures in the order they appear.

pub fn capture( &self, index: usize ) -> Option<QueryCapture<'query, 'tree, Custom>>

Get the capture at the given index (order it appears).

pub fn capture_named( &self, name: &str ) -> Option<QueryCapture<'query, 'tree, Custom>>

Get the first occurrence of the capture with the given name.

pub fn captures_named<'a>( &'a self, name: &'a str ) -> impl Iterator<Item = QueryCapture<'query, 'tree, Custom>> + 'a

Get every occurrence of the captures with the given name.

pub fn capture_count(&self) -> usize

Get the number of captures in this match.

pub fn pattern_index(&self) -> usize

Get the pattern index of this match.

pub fn id(&self) -> u32

Get the id of this match (honestly I don’t know what this does because it’s not documented)

pub fn remove(self)

Remove the match (honestly I don’t know what this does because it’s not documented)

pub fn nodes_for_capture_index( &self, capture_index: u32 ) -> impl Iterator<Item = Node<'tree, Custom>> + '_

Get the nodes that were captures by the capture at the given index.

Trait Implementations

impl<'query, 'tree, Custom> Debug for QueryMatch<'query, 'tree, Custom>

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

Formats the value using the given formatter.