Struct SourceIndex 

pub struct SourceIndex {
    pub definitions: DefinitionIndex,
    pub references: ReferenceIndex,
    pub symbols: Vec<DocumentSymbol>,
    pub regions: Vec<SourceRegion>,
}

A combined source index with definitions, references, and symbols.

Fields

definitions: DefinitionIndex

Definition index.

references: ReferenceIndex

Reference index.

symbols: Vec<DocumentSymbol>

Document symbols.

regions: Vec<SourceRegion>

Source regions.

Implementations

impl SourceIndex

pub fn new() -> Self

Create an empty source index.

pub fn register_definition(&mut self, name: impl Into<String>, span: Span)

Register a definition.

pub fn record_reference(&mut self, name: impl Into<String>, span: Span)

Record a reference.

pub fn add_symbol(&mut self, symbol: DocumentSymbol)

Add a document symbol.

pub fn add_region(&mut self, region: SourceRegion)

Add a source region.

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

Find the symbol at a given byte offset.

pub fn definition_spans(&self, name: &str) -> &[Span]

Get all definition spans for a name.

pub fn reference_spans(&self, name: &str) -> &[Span]

Get all use-site spans for a name.

pub fn top_level_symbols(&self) -> &[DocumentSymbol]

Symbols that are top-level definitions (not inside a namespace).

Trait Implementations

impl Clone for SourceIndex

fn clone(&self) -> SourceIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceIndex

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

Formats the value using the given formatter.

impl Default for SourceIndex

fn default() -> SourceIndex

Returns the “default value” for a type.