Struct SymbolIndex 

pub struct SymbolIndex {
    pub definitions: Vec<Definition>,
    pub references: Vec<Reference>,
    pub name_to_defs: HashMap<String, Vec<usize>>,
    pub block_spans: Vec<(String, BlockType, Span)>,
    pub statement_spans: Vec<(String, Span)>,
    pub call_sites: Vec<CallSite>,
}

The symbol index for a single document.

Fields

definitions: Vec<Definition>

references: Vec<Reference>

name_to_defs: HashMap<String, Vec<usize>>

block_spans: Vec<(String, BlockType, Span)>

Maps block header names to their spans.

statement_spans: Vec<(String, Span)>

Statement spans inferred from keyword..period token ranges.

call_sites: Vec<CallSite>

Function call sites (f(…) and Call f …), caller-resolved.

Implementations

impl SymbolIndex

pub fn build( stmts: &[OwnedStmt], tokens: &[Token], type_registry: &TypeRegistry, interner: &Interner, source: &str, ) -> Self

Build the symbol index from parsed statements, tokens, the type registry, and the source text (literate docs read the prose).

pub fn enclosing_function(&self, offset: usize) -> Option<usize>

The function definition whose block contains offset, if any.

pub fn definition_at(&self, offset: usize) -> Option<&Definition>

Find the definition at the given byte offset.

pub fn definition_at_scoped( &self, name: &str, offset: usize, ) -> Option<&Definition>

Scope-aware definition lookup. Given a byte offset for context, returns the definition of name in the nearest scope.

pub fn references_to(&self, name: &str) -> Vec<&Reference>

Find all references to the definition with the given name.

pub fn references_in_scope( &self, name: &str, def_offset: usize, ) -> Vec<&Reference>

Find references to name that are in the same scope as the definition at def_offset.

pub fn definitions_of(&self, name: &str) -> Vec<&Definition>

Find all definitions with the given name.

pub fn block_name(&self, block_idx: usize) -> Option<&str>

Get the block name for a block index.

Trait Implementations

impl Clone for SymbolIndex

fn clone(&self) -> SymbolIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolIndex

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

Formats the value using the given formatter.

impl Default for SymbolIndex

fn default() -> SymbolIndex

Returns the “default value” for a type.