Skip to main content

SymbolReference

Struct SymbolReference 

Source
pub struct SymbolReference {
    pub name: String,
    pub kind: SymbolKind,
    pub location: SourceLocation,
    pub scope_id: ScopeId,
    pub is_write: bool,
}
Expand description

A reference to a symbol with usage context for LSP analysis.

Tracks symbol usage sites for features like find-all-references, rename refactoring, and unused symbol detection with precise scope and context information.

§Performance Characteristics

  • Memory: ~64 bytes per reference
  • Collection: O(n) during AST traversal
  • Query time: O(log n) with spatial indexing

§LSP Integration

Essential for:

  • Find references: Locate all usage sites
  • Rename refactoring: Update all references atomically
  • Unused detection: Identify unreferenced symbols
  • Call hierarchy: Build caller/callee relationships

Fields§

§name: String

Symbol name (without sigil for variables)

§kind: SymbolKind

Symbol type inferred from usage context

§location: SourceLocation

Source location of the reference

§scope_id: ScopeId

Lexical scope where reference occurs

§is_write: bool

Whether this is a write reference (assignment)

Trait Implementations§

Source§

impl Clone for SymbolReference

Source§

fn clone(&self) -> SymbolReference

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SymbolReference

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.