Struct CompletionCtx 

pub struct CompletionCtx<'a> {
    pub source: Option<&'a str>,
    pub position: Option<Position>,
    pub doc_uri: Option<&'a Uri>,
    pub file_imports: Option<&'a HashMap<String, String>>,
    pub find_class_doc: Option<ClassDocLookup<'a>>,
    pub workspace_class_search: Option<WorkspaceClassSearch<'a>>,
    pub analysis: Option<&'a FileAnalysis>,
    pub session: Option<&'a DocumentStore>,
    pub laravel: Option<&'a LaravelIndex>,
}

Optional context for completion requests that enables richer results (e.g. auto-import edits, -> scoping to a class).

Fields

source: Option<&'a str>

position: Option<Position>

doc_uri: Option<&'a Uri>

file_imports: Option<&'a HashMap<String, String>>

find_class_doc: Option<ClassDocLookup<'a>>

Optional O(1) class-document lookup backed by the workspace index. When Some, all_instance_members and all_static_members use it to find the defining doc directly instead of scanning other_docs linearly (O(n files × inheritance depth) → O(depth)). Pass None to fall back to the existing linear scan.

workspace_class_search: Option<WorkspaceClassSearch<'a>>

Optional workspace-wide class name search backed by the workspace index (see WorkspaceClassSearch). Used to suggest — and auto-import — classes from files that aren’t currently open, such as vendor code. None in unit tests that don’t supply it.

analysis: Option<&'a FileAnalysis>

Retained mir body analysis for the primary doc. Receiver-variable types ($obj->, match subjects) are read from its symbol_at; None in unit tests that don’t supply it.

session: Option<&'a DocumentStore>

Store handle for querying phpstorm-stubs member info on built-in PHP classes via its mir-analyzer session. A handle rather than a borrowed &mut AnalysisSession: find_class_doc (above) can itself lock the session (DocumentStore::resolve_class_ref_by_fqn), and mir’s session mutex isn’t reentrant, so nothing here may hold it across that call — each session use below is its own short-lived lock. None in unit tests that don’t require stubs.

laravel: Option<&'a LaravelIndex>

Laravel string-key index (env/config/view/… — see crate::laravel), for completion inside those helper calls’ string arguments. None in unit tests that don’t supply it, and inert (empty) for non-Laravel workspaces.

Trait Implementations

impl<'a> Default for CompletionCtx<'a>

fn default() -> Self

Returns the “default value” for a type.