Struct CompletionCtx 

pub struct CompletionCtx<'a> {
    pub source: Option<&'a str>,
    pub position: Option<Position>,
    pub meta: Option<&'a PhpStormMeta>,
    pub doc_uri: Option<&'a Url>,
    pub file_imports: Option<&'a HashMap<String, String>>,
    pub find_class_doc: Option<ClassDocLookup<'a>>,
    pub analysis: Option<&'a FileAnalysis>,
    pub type_map: Option<&'a dyn Fn() -> Arc<TypeMap>>,
    pub session: Option<Arc<AnalysisSession>>,
}

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>

meta: Option<&'a PhpStormMeta>

doc_uri: Option<&'a Url>

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.

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.

type_map: Option<&'a dyn Fn() -> Arc<TypeMap>>

Optional cross-request cache for the whole-doc TypeMap. The backend wires this to DocumentStore::cached_type_map so the receiver-type paths (->, ::, match arms) reuse one map per document revision instead of walking the full AST on every completion request. None (unit tests) builds the map fresh.

session: Option<Arc<AnalysisSession>>

mir-analyzer session for querying phpstorm-stubs member info on built-in PHP classes. None in unit tests that don’t require stubs.

Trait Implementations

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

fn default() -> CompletionCtx<'a>

Returns the “default value” for a type.