Struct Symbol 

pub struct Symbol {
    pub name: String,
    pub qualified_name: String,
    pub kind: SymbolKind,
    pub location: ByteSpan,
    pub scope_id: usize,
    pub declaration: Option<String>,
    pub documentation: Option<String>,
    pub attributes: Vec<String>,
}

Symbol extraction, table, and reference types for navigation. A symbol definition in Perl code with comprehensive metadata for Index/Navigate workflows.

Represents a symbol definition with full context including scope, package qualification, and documentation for LSP features like go-to-definition, hover, and workspace symbols.

Performance Characteristics

• Memory: ~128 bytes per symbol (optimized for large codebases)
• Lookup time: O(1) via hash table indexing
• Scope resolution: O(log n) with scope hierarchy

Perl Language Semantics

• Package qualification: Package::symbol vs bare symbol
• Scope rules: Lexical (my), package (our), dynamic (local), persistent (state)
• Symbol types: Variables ($, @, %), subroutines, packages, constants
• Attribute parsing: :shared, :method, :lvalue and custom attributes

Fields

name: String

Symbol name (without sigil for variables)

qualified_name: String

Fully qualified name with package prefix

kind: SymbolKind

Classification of symbol type

location: ByteSpan

Source location of symbol definition

scope_id: usize

Lexical scope identifier for visibility rules

declaration: Option<String>

Variable declaration type (my, our, local, state)

documentation: Option<String>

Extracted POD or comment documentation

attributes: Vec<String>

Perl attributes applied to the symbol

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.