Struct ScopeDetector 

pub struct ScopeDetector { /* private fields */ }

A reusable per-language detector that runs a tags query over source bytes and yields NamedScopes.

Construct once per grammar (the query is compiled inside TagsConfiguration::new); reuse across many files. The internal TagsContext holds a tree-sitter Parser and QueryCursor that are reset between calls.

Implementations

impl ScopeDetector

pub fn new( language: &Language, base_query: Option<&str>, project_override: Option<&str>, ) -> Result<Self, ParseError>

Build a detector from a grammar’s tags query.

Pass None for base_query if the grammar does not ship a queries/tags.scm; the detector is then a no-op (always returns an empty scope list). Pass Some(project_override) to concatenate an override query in front of the base (tree-sitter unions all patterns, so override captures augment the grammar defaults).

Errors

Returns ParseError::ScopeQueryCompile if the combined query fails to compile against the given language (malformed S-expression, unknown capture name outside the tags-query vocabulary, etc.).

pub const fn has_query(&self) -> bool

True when this detector has a compiled tags query and will produce scopes. A detector constructed from (None, None) is a no-op.

pub fn scopes(&mut self, source: &[u8]) -> Vec<NamedScope>

Run the tags query over source and return every @definition.* match as a NamedScope.

Non-definition captures (@reference.*, etc.) are filtered out: they describe call sites, not scopes. @ignore matches (used by grammars like Elixir to suppress false positives) are handled internally by tree-sitter-tags.

Ordering mirrors tree-sitter’s match order (roughly source order, with potential reordering when patterns overlap). Callers that need a deterministic byte-ordered index should sort the result.

Trait Implementations

impl Debug for ScopeDetector

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

Formats the value using the given formatter.