Struct Analysis 

pub struct Analysis { /* private fields */ }

An immutable snapshot of the world — a cloned salsa handle. Every query is Cancellable: a concurrent apply_change cancels in-flight reads, which the client re-issues against the fresh snapshot.

Implementations

impl Analysis

pub fn syntax_tree(&self, file: FileId) -> Cancellable<Option<String>>

A pretty-printed dump of the syntax tree (debugging / playground).

Errors

Err(Cancelled) if a concurrent apply_change invalidated this snapshot.

pub fn diagnostics(&self, file: FileId) -> Cancellable<Vec<Diagnostic>>

Parse-error diagnostics ∪ the Phase-2 §5 type diagnostics.

Errors

See Analysis::syntax_tree.

pub fn format(&self, file: FileId) -> Cancellable<Option<String>>

Format file’s source, returning the tidied text — or None if the file is unknown. Safe by construction: it normalizes whitespace + indentation and never changes meaning, falling back to the original on anything it can’t safely reformat (see gdscript_fmt).

Errors

See Analysis::syntax_tree.

pub fn document_symbols(&self, file: FileId) -> Cancellable<Vec<DocumentSymbol>>

The document outline (classes, funcs, vars, consts, enums, signals, members).

Errors

See Analysis::syntax_tree.

pub fn semantic_tokens(&self, file: FileId) -> Cancellable<Vec<SemanticToken>>

Semantic-highlighting tokens: each meaningful token classified by its contextual role (declarations, types, parameters, members, calls, literals, comments) — richer than a grammar. In source order.

Errors

See Analysis::syntax_tree.

pub fn folding_ranges(&self, file: FileId) -> Cancellable<Vec<FoldRange>>

Foldable ranges (blocks, #region pairs, multi-line brackets).

Errors

See Analysis::syntax_tree.

pub fn completions(&self, pos: FilePosition) -> Cancellable<Vec<CompletionItem>>

Completions. After receiver. it offers the inferred member set; otherwise (or when the receiver is Variant/Unknown) it falls back to the Tier-0 by-name completion (keywords, annotations after @, document-local symbols) so it never regresses.

Errors

See Analysis::syntax_tree.

pub fn hover(&self, pos: FilePosition) -> Cancellable<Option<HoverResult>>

Hover: the inferred type of the expression / binding under the cursor (Unknown elided). None when there is nothing typed there.

Errors

See Analysis::syntax_tree.

pub fn inlay_hints(&self, file: FileId) -> Cancellable<Vec<InlayHint>>

Inlay : T hints on := declarations + unannotated params / for-vars (suppressed when the type is Variant/Unknown).

Errors

See Analysis::syntax_tree.

pub fn signature_help( &self, pos: FilePosition, ) -> Cancellable<Option<SignatureHelp>>

Signature help at a call site (active parameter by top-level comma count).

Errors

See Analysis::syntax_tree.

pub fn code_actions(&self, pos: FilePosition) -> Cancellable<Vec<CodeAction>>

Code actions at a position (currently “add type annotation”).

Errors

See Analysis::syntax_tree.

pub fn goto_definition(&self, pos: FilePosition) -> Cancellable<Vec<NavTarget>>

Go-to-definition: the declaration target(s) of the symbol under the cursor (cross-file).

Errors

See Analysis::syntax_tree.

pub fn find_references(&self, pos: FilePosition) -> Cancellable<Vec<Reference>>

Find every reference to the symbol under the cursor, project-wide (incl. its declaration).

Errors

See Analysis::syntax_tree.

pub fn rename( &self, pos: FilePosition, new_name: &str, ) -> Cancellable<Result<SourceChange, RenameError>>

Rename the symbol under the cursor to new_name — a cross-file edit, or a refusal (RenameError); never a partial edit.

Errors

Err(Cancelled) if a concurrent apply_change invalidated this snapshot. The rename’s own refusal is the Result inside the Cancellable.

pub fn workspace_symbols(&self, query: &str) -> Cancellable<Vec<NavTarget>>

Project-wide symbols matching query (fuzzy-ranked class names + members).

Errors

See Analysis::syntax_tree.

Trait Implementations

impl Clone for Analysis

fn clone(&self) -> Analysis

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Analysis

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

Formats the value using the given formatter.