Skip to main content

ScopeEngine

Struct ScopeEngine 

Source
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>

Source

pub fn new(loader: &'a GrammarLoader) -> Self

Source

pub fn has_locals(&self, lang: &str) -> bool

Returns true if locals.scm is available for this language.

Source

pub fn find_definitions( &self, lang: &str, source: &str, name: &str, ) -> Vec<Definition>

Find all definitions of name in source.

Source

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.

Source

pub fn all_definitions(&self, lang: &str, source: &str) -> Vec<Definition>

Get all definitions in source.

Source

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more