pub struct ScopeEngine<'a> { /* private fields */ }Expand description
Scope analysis engine backed by tree-sitter locals queries.
Requires locals.scm query files to be present in the grammar search paths
(copied there by cargo xtask build-grammars).
Implementations§
Source§impl<'a> ScopeEngine<'a>
impl<'a> ScopeEngine<'a>
pub fn new(loader: &'a GrammarLoader) -> Self
Sourcepub fn has_locals(&self, lang: &str) -> bool
pub fn has_locals(&self, lang: &str) -> bool
Returns true if locals.scm is available for this language.
Sourcepub fn find_definitions(
&self,
lang: &str,
source: &str,
name: &str,
) -> Vec<Definition>
pub fn find_definitions( &self, lang: &str, source: &str, name: &str, ) -> Vec<Definition>
Find all definitions of name in source.
Sourcepub fn find_references(
&self,
lang: &str,
source: &str,
name: &str,
) -> Vec<Reference>
pub fn find_references( &self, lang: &str, source: &str, name: &str, ) -> Vec<Reference>
Find all references to name in source, with definition resolution.
Returns both definition sites and reference sites that resolve to any
definition of name in this file.
Sourcepub fn all_definitions(&self, lang: &str, source: &str) -> Vec<Definition>
pub fn all_definitions(&self, lang: &str, source: &str) -> Vec<Definition>
Get all definitions in source.
Sourcepub fn find_unused_parameters(
&self,
lang: &str,
source: &str,
) -> Vec<Definition>
pub fn find_unused_parameters( &self, lang: &str, source: &str, ) -> Vec<Definition>
Find parameters that are never referenced in their enclosing function body.
Returns definitions whose kind is "parameter" and whose name has no
resolved reference in the same file. Underscore-prefixed names (_, _foo)
are excluded — those are the conventional way to mark intentionally unused
parameters in most languages.
Requires @local.definition.parameter captures in the language’s locals.scm.
Languages without that capture produce an empty result.
Auto Trait Implementations§
impl<'a> Freeze for ScopeEngine<'a>
impl<'a> RefUnwindSafe for ScopeEngine<'a>
impl<'a> Send for ScopeEngine<'a>
impl<'a> Sync for ScopeEngine<'a>
impl<'a> Unpin for ScopeEngine<'a>
impl<'a> UnsafeUnpin for ScopeEngine<'a>
impl<'a> UnwindSafe for ScopeEngine<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request