Struct SymbolTable 

pub struct SymbolTable { /* private fields */ }

The scope tree of a program, the symbols each scope declares, every use of those symbols, and the files they live in.

Implementations

impl SymbolTable

pub const GLOBAL: ScopeId = 0

The main file’s global scope, always present.

pub const MAIN: FileId = 0

The main file’s id, always present.

pub fn file_path(&self, file: FileId) -> &str

pub fn file_root(&self, file: FileId) -> ScopeId

pub fn files(&self) -> impl Iterator<Item = (FileId, &str)>

pub fn scope_file(&self, scope: ScopeId) -> FileId

pub fn symbols(&self) -> &[Symbol]

Every symbol declared anywhere, in declaration order.

pub fn scope_kind(&self, scope: ScopeId) -> ScopeKind

The kind of a scope.

pub fn symbols_in(&self, scope: ScopeId) -> impl Iterator<Item = &Symbol>

The symbols reachable by bare name directly in scope.

pub fn members_of(&self, owner: SymbolId) -> impl Iterator<Item = &Symbol>

The members (fields, enum cases) of a type or enum symbol — the candidates for completion after owner..

pub fn member_id(&self, owner: SymbolId, name: &str) -> Option<SymbolId>

The member of owner named name, if any — resolves owner.name.

pub fn exported_id(&self, scope: ScopeId, name: &str) -> Option<SymbolId>

An exported symbol named name declared directly in scope — how a member access resolves against an imported library’s global scope.

pub fn declaration_location(&self, id: SymbolId) -> Option<(FileId, u32, u32)>

A symbol’s declaration location as (file, line, column) — go-to-def, including into an imported library file.

pub fn symbol(&self, id: SymbolId) -> &Symbol

The symbol at index id.

pub fn resolve(&self, scope: ScopeId, name: &str) -> Option<&Symbol>

Resolve name from scope outward, innermost first.

pub fn resolve_id(&self, scope: ScopeId, name: &str) -> Option<SymbolId>

Like resolve but returns the symbol’s id, so a use can be recorded against it.

pub fn references( &self, symbol: SymbolId, ) -> impl Iterator<Item = (FileId, u32, u32)> + '_

pub fn occurrences_in_file( &self, file: FileId, ) -> impl Iterator<Item = (u32, u32, SymbolId)> + '_

pub fn symbol_at( &self, file: FileId, line: u32, column: u32, ) -> Option<SymbolId>

The symbol referenced or declared at (file, line, column) — hover and go-to-definition, whether the cursor sits on a use or the declaration.

pub fn find_declaration_at( &self, file: FileId, line: u32, column: u32, ) -> Option<&Symbol>

The symbol declared at (file, line, column), if any.

Trait Implementations

impl Clone for SymbolTable

fn clone(&self) -> SymbolTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolTable

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

Formats the value using the given formatter.