Enum Symbol 

pub enum Symbol {
    Class(Arc<str>),
    Function(Arc<str>),
    Method {
        class: Arc<str>,
        name: Arc<str>,
    },
    Property {
        class: Arc<str>,
        name: Arc<str>,
    },
    ClassConstant {
        class: Arc<str>,
        name: Arc<str>,
    },
    GlobalConstant(Arc<str>),
}

A semantic identifier for a code entity that the analyzer can resolve.

Replaces the previous stringly-typed &str keys. Method names are normalized (lowercased) at construction since PHP method dispatch is case-insensitive — this prevents a class of correctness bugs where callers pass mixed-case names and get empty results.

Variants

Class(Arc<str>)

A class, interface, trait, or enum (FQCN).

Function(Arc<str>)

A global function (FQN).

Method

An instance or static method.

Fields

class: Arc<str>

name: Arc<str>

Property

A class property.

Fields

class: Arc<str>

name: Arc<str>

ClassConstant

A class / interface / enum constant.

Fields

class: Arc<str>

name: Arc<str>

GlobalConstant(Arc<str>)

A global constant.

Implementations

impl Symbol

pub fn method(class: impl Into<Arc<str>>, name: &str) -> Self

Construct a method symbol. Normalizes name to lowercase since PHP methods are case-insensitive.

pub fn class(fqcn: impl Into<Arc<str>>) -> Self

Construct a class symbol.

pub fn function(fqn: impl Into<Arc<str>>) -> Self

Construct a function symbol.

pub fn property(class: impl Into<Arc<str>>, name: impl Into<Arc<str>>) -> Self

Construct a property symbol.

pub fn class_constant( class: impl Into<Arc<str>>, name: impl Into<Arc<str>>, ) -> Self

Construct a class constant symbol.

pub fn global_constant(fqn: impl Into<Arc<str>>) -> Self

Construct a global constant symbol.

pub fn codebase_key(&self) -> String

The codebase lookup key for this symbol (used internally for the reference-locations index). Stable across releases.

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

Formats the value using the given formatter.

impl Hash for Symbol

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Symbol

fn eq(&self, other: &Symbol) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Symbol

impl StructuralPartialEq for Symbol