Skip to main content

WorkspaceIndexData

Struct WorkspaceIndexData 

Source
pub struct WorkspaceIndexData {
    pub files: Vec<(Url, Arc<FileIndex>)>,
    pub classes_by_name: HashMap<String, Vec<ClassRef>>,
    pub subtypes_of: HashMap<Arc<str>, Vec<ClassRef>>,
    pub decls_by_name: HashMap<String, Vec<DeclRef>>,
    pub classes_by_lowercase_name: Vec<(Box<str>, ClassRef)>,
}
Expand description

Aggregated workspace-level index. Constructed once per salsa revision by workspace_index and held behind an Arc for cheap cross-request sharing.

Fields§

§files: Vec<(Url, Arc<FileIndex>)>§classes_by_name: HashMap<String, Vec<ClassRef>>§subtypes_of: HashMap<Arc<str>, Vec<ClassRef>>

parent_or_interface_or_trait_name → [subtype ClassRef]. A class that extends X AND implements Y contributes separate entries under both keys. Keyed by Arc<str> so insertions from ClassDef’s already-interned fields are pointer copies rather than heap allocations.

§decls_by_name: HashMap<String, Vec<DeclRef>>

declared_name → [DeclRef] over every function, class, method, property (stored without $), class constant, and enum case in the workspace; enables O(1) go-to-definition lookups.

§classes_by_lowercase_name: Vec<(Box<str>, ClassRef)>

One (lowercase_short_name, ClassRef) pair per distinct class name, sorted by the lowercase key. Built once per revision so completion’s prefix search can binary-search a range instead of scanning every class name (and re-lowercasing it) on every keystroke.

Implementations§

Source§

impl WorkspaceIndexData

Source

pub fn at(&self, r: ClassRef) -> Option<(&Url, &ClassDef)>

Resolve a ClassRef back to its (uri, class_def) pair.

Source

pub fn resolve_class_ref(&self, name: &str) -> Option<ClassRef>

Resolve name to a single ClassRef, disambiguating same-named classes in different namespaces. classes_by_name is keyed by short name only, so two unrelated classes sharing a name (e.g. Laravel’s Illuminate\Support\Facades\Auth vs Illuminate\Container\Attributes\ Auth) collide in one bucket; picking .first() unconditionally silently returns whichever happens to be indexed first.

name may be a bare short name (kept for compatibility — resolves to the first match, as before) or a fully-qualified name (Foo\Bar\Baz, optionally leading with \), in which case the candidate whose own FQN matches (case-insensitively, PHP class names are case-insensitive) is preferred over an arbitrary first match.

Source

pub fn find_declaration( &self, name: &str, exclude: Option<&Url>, ) -> Option<Location>

O(1) replacement for the linear find_declaration_in_indexes scan: find a declaration by name, optionally excluding one file (the current document, which the caller has already searched with accurate AST ranges). Matching rules mirror the old scan: a sigil query ($foo) matches functions, classes, and properties named foo; a bare query matches every declaration kind. Returns a zero-width line Location.

Source

pub fn from_files(files: Vec<(Url, Arc<FileIndex>)>) -> Self

Constructor that builds the reverse maps from an already-materialised (Url, Arc<FileIndex>) slice. Exposed so callers that don’t want to spin up a full AnalysisHost (unit tests of find_implementations_from_workspace, benchmark crates) can exercise the aggregate-shaped helpers directly. Production code goes through the workspace_index salsa query instead.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Lookup<T> for T

Source§

fn into_owned(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more