Struct Backend 

pub struct Backend { /* private fields */ }

Implementations

impl Backend

pub fn new(client: Client) -> Self

pub async fn debug_stats(&self) -> Result<DebugStats>

$/php-lsp/debugStats — internal observability counters, used by the stress tests to assert the read path doesn’t parse the whole workspace and that reference-index lock traffic stays bounded per operation.

Trait Implementations

impl LanguageServer for Backend

async fn will_delete_files( &self, params: DeleteFilesParams, ) -> Result<Option<WorkspaceEdit>>

Before a file is deleted, return workspace edits that remove every use import referencing its PSR-4 class name.

async fn initialize(&self, params: InitializeParams) -> Result<InitializeResult>

The initialize request is the first request sent from the client to the server.

async fn initialized(&self, _params: InitializedParams)

The initialized notification is sent from the client to the server after the client received the result of the initialize request but before the client sends anything else.

async fn did_change_configuration(&self, _params: DidChangeConfigurationParams)

The workspace/didChangeConfiguration notification is sent from the client to the server to signal the change of configuration settings.

async fn did_change_workspace_folders( &self, params: DidChangeWorkspaceFoldersParams, )

The workspace/didChangeWorkspaceFolders notification is sent from the client to the server to inform about workspace folder configuration changes.

async fn shutdown(&self) -> Result<()>

The shutdown request asks the server to gracefully shut down, but to not exit.

async fn did_open(&self, params: DidOpenTextDocumentParams)

The textDocument/didOpen notification is sent from the client to the server to signal that a new text document has been opened by the client.

async fn did_change(&self, params: DidChangeTextDocumentParams)

The textDocument/didChange notification is sent from the client to the server to signal changes to a text document.

async fn did_close(&self, params: DidCloseTextDocumentParams)

The textDocument/didClose notification is sent from the client to the server when the document got closed in the client.

async fn will_save(&self, _params: WillSaveTextDocumentParams)

The textDocument/willSave notification is sent from the client to the server before the document is actually saved.

async fn will_save_wait_until( &self, params: WillSaveTextDocumentParams, ) -> Result<Option<Vec<TextEdit>>>

The textDocument/willSaveWaitUntil request is sent from the client to the server before the document is actually saved.

async fn did_save(&self, params: DidSaveTextDocumentParams)

The textDocument/didSave notification is sent from the client to the server when the document was saved in the client.

async fn did_change_watched_files(&self, params: DidChangeWatchedFilesParams)

The workspace/didChangeWatchedFiles notification is sent from the client to the server when the client detects changes to files watched by the language client.

async fn completion( &self, params: CompletionParams, ) -> Result<Option<CompletionResponse>>

The textDocument/completion request is sent from the client to the server to compute completion items at a given cursor position.

async fn completion_resolve( &self, item: CompletionItem, ) -> Result<CompletionItem>

The completionItem/resolve request is sent from the client to the server to resolve additional information for a given completion item.

async fn goto_definition( &self, params: GotoDefinitionParams, ) -> Result<Option<GotoDefinitionResponse>>

The textDocument/definition request asks the server for the definition location of a symbol at a given text document position.

async fn references( &self, params: ReferenceParams, ) -> Result<Option<Vec<Location>>>

The textDocument/references request is sent from the client to the server to resolve project-wide references for the symbol denoted by the given text document position.

async fn prepare_rename( &self, params: TextDocumentPositionParams, ) -> Result<Option<PrepareRenameResponse>>

The textDocument/prepareRename request is sent from the client to the server to setup and test the validity of a rename operation at a given location.

async fn rename(&self, params: RenameParams) -> Result<Option<WorkspaceEdit>>

The textDocument/rename request is sent from the client to the server to ask the server to compute a workspace change so that the client can perform a workspace-wide rename of a symbol.

async fn signature_help( &self, params: SignatureHelpParams, ) -> Result<Option<SignatureHelp>>

The textDocument/signatureHelp request is sent from the client to the server to request signature information at a given cursor position.

async fn hover(&self, params: HoverParams) -> Result<Option<Hover>>

The textDocument/hover request asks the server for hover information at a given text document position.

async fn document_symbol( &self, params: DocumentSymbolParams, ) -> Result<Option<DocumentSymbolResponse>>

The textDocument/documentSymbol request is sent from the client to the server to retrieve all symbols found in a given text document.

async fn folding_range( &self, params: FoldingRangeParams, ) -> Result<Option<Vec<FoldingRange>>>

The textDocument/foldingRange request is sent from the client to the server to return all folding ranges found in a given text document.

async fn inlay_hint( &self, params: InlayHintParams, ) -> Result<Option<Vec<InlayHint>>>

The textDocument/inlayHint request is sent from the client to the server to compute inlay hints for a given (text document, range) tuple that may be rendered in the editor in place with other text.

async fn inlay_hint_resolve(&self, item: InlayHint) -> Result<InlayHint>

The inlayHint/resolve request is sent from the client to the server to resolve additional information for a given inlay hint.

async fn symbol( &self, params: WorkspaceSymbolParams, ) -> Result<Option<WorkspaceSymbolResponse>>

The workspace/symbol request is sent from the client to the server to list project-wide symbols matching the given query string.

async fn symbol_resolve( &self, params: WorkspaceSymbol, ) -> Result<WorkspaceSymbol>

The workspaceSymbol/resolve request is sent from the client to the server to resolve additional information for a given workspace symbol.

async fn semantic_tokens_full( &self, params: SemanticTokensParams, ) -> Result<Option<SemanticTokensResult>>

The textDocument/semanticTokens/full request is sent from the client to the server to resolve the semantic tokens of a given file.

async fn semantic_tokens_range( &self, params: SemanticTokensRangeParams, ) -> Result<Option<SemanticTokensRangeResult>>

The textDocument/semanticTokens/range request is sent from the client to the server to resolve the semantic tokens for the visible range of a given file.

async fn semantic_tokens_full_delta( &self, params: SemanticTokensDeltaParams, ) -> Result<Option<SemanticTokensFullDeltaResult>>

The textDocument/semanticTokens/full/delta request is sent from the client to the server to resolve the semantic tokens of a given file, returning only the delta.

async fn selection_range( &self, params: SelectionRangeParams, ) -> Result<Option<Vec<SelectionRange>>>

The textDocument/selectionRange request is sent from the client to the server to return suggested selection ranges at an array of given positions. A selection range is a range around the cursor position which the user might be interested in selecting.

async fn prepare_call_hierarchy( &self, params: CallHierarchyPrepareParams, ) -> Result<Option<Vec<CallHierarchyItem>>>

The textDocument/prepareCallHierarchy request is sent from the client to the server to return a call hierarchy for the language element of given text document positions.

async fn incoming_calls( &self, params: CallHierarchyIncomingCallsParams, ) -> Result<Option<Vec<CallHierarchyIncomingCall>>>

The callHierarchy/incomingCalls request is sent from the client to the server to resolve incoming calls for a given call hierarchy item.

async fn outgoing_calls( &self, params: CallHierarchyOutgoingCallsParams, ) -> Result<Option<Vec<CallHierarchyOutgoingCall>>>

The callHierarchy/outgoingCalls request is sent from the client to the server to resolve outgoing calls for a given call hierarchy item.

async fn document_highlight( &self, params: DocumentHighlightParams, ) -> Result<Option<Vec<DocumentHighlight>>>

The textDocument/documentHighlight request is sent from the client to the server to resolve appropriate highlights for a given text document position.

async fn linked_editing_range( &self, params: LinkedEditingRangeParams, ) -> Result<Option<LinkedEditingRanges>>

The textDocument/linkedEditingRange request is sent from the client to the server to return for a given position in a document the range of the symbol at the position and all ranges that have the same content.

async fn goto_implementation( &self, params: GotoImplementationParams, ) -> Result<Option<GotoImplementationResponse>>

The textDocument/implementation request is sent from the client to the server to resolve the implementation location of a symbol at a given text document position.

async fn goto_declaration( &self, params: GotoDeclarationParams, ) -> Result<Option<GotoDeclarationResponse>>

The textDocument/declaration request asks the server for the declaration location of a symbol at a given text document position.

async fn goto_type_definition( &self, params: GotoTypeDefinitionParams, ) -> Result<Option<GotoTypeDefinitionResponse>>

The textDocument/typeDefinition request asks the server for the type definition location of a symbol at a given text document position.

async fn prepare_type_hierarchy( &self, params: TypeHierarchyPrepareParams, ) -> Result<Option<Vec<TypeHierarchyItem>>>

The textDocument/prepareTypeHierarchy request is sent from the client to the server to return a type hierarchy for the language element of given text document positions.

async fn supertypes( &self, params: TypeHierarchySupertypesParams, ) -> Result<Option<Vec<TypeHierarchyItem>>>

The [typeHierarchy/supertypes] request is sent from the client to the server to resolve the supertypes for a given type hierarchy item.

async fn subtypes( &self, params: TypeHierarchySubtypesParams, ) -> Result<Option<Vec<TypeHierarchyItem>>>

The [typeHierarchy/subtypes] request is sent from the client to the server to resolve the subtypes for a given type hierarchy item.

async fn code_lens( &self, params: CodeLensParams, ) -> Result<Option<Vec<CodeLens>>>

The textDocument/codeLens request is sent from the client to the server to compute code lenses for a given text document.

async fn code_lens_resolve(&self, params: CodeLens) -> Result<CodeLens>

The codeLens/resolve request is sent from the client to the server to resolve the command for a given code lens item.

async fn document_link( &self, params: DocumentLinkParams, ) -> Result<Option<Vec<DocumentLink>>>

The textDocument/documentLink request is sent from the client to the server to request the location of links in a document.

async fn document_link_resolve( &self, params: DocumentLink, ) -> Result<DocumentLink>

The documentLink/resolve request is sent from the client to the server to resolve the target of a given document link.

async fn formatting( &self, params: DocumentFormattingParams, ) -> Result<Option<Vec<TextEdit>>>

The textDocument/formatting request is sent from the client to the server to format a whole document.

async fn range_formatting( &self, params: DocumentRangeFormattingParams, ) -> Result<Option<Vec<TextEdit>>>

The textDocument/rangeFormatting request is sent from pub(crate) the client to the server to format a given range in a document.

async fn on_type_formatting( &self, params: DocumentOnTypeFormattingParams, ) -> Result<Option<Vec<TextEdit>>>

The textDocument/onTypeFormatting request is sent from the client to the server to format parts of the document during typing.

async fn execute_command( &self, params: ExecuteCommandParams, ) -> Result<Option<Value>>

The workspace/executeCommand request is sent from the client to the server to trigger command execution on the server.

async fn will_rename_files( &self, params: RenameFilesParams, ) -> Result<Option<WorkspaceEdit>>

The workspace/willRenameFiles request is sent from the client to the server before files are actually renamed as long as the rename is triggered from within the client.

async fn did_rename_files(&self, params: RenameFilesParams)

The workspace/didRenameFiles notification is sent from the client to the server when files were renamed from within the client.

async fn will_create_files( &self, params: CreateFilesParams, ) -> Result<Option<WorkspaceEdit>>

The workspace/willCreateFiles request is sent from the client to the server before files are actually created as long as the creation is triggered from within the client.

async fn did_create_files(&self, params: CreateFilesParams)

The workspace/didCreateFiles request is sent from the client to the server when files were created from within the client.

async fn did_delete_files(&self, params: DeleteFilesParams)

The workspace/didDeleteFiles notification is sent from the client to the server when files were deleted from within the client.

async fn moniker(&self, params: MonikerParams) -> Result<Option<Vec<Moniker>>>

The textDocument/moniker request is sent from the client to the server to get the symbol monikers for a given text document position.

async fn inline_value( &self, params: InlineValueParams, ) -> Result<Option<Vec<InlineValue>>>

The textDocument/inlineValue request is sent from the client to the server to compute inline values for a given text document that may be rendered in the editor at the end of lines.

async fn diagnostic( &self, params: DocumentDiagnosticParams, ) -> Result<DocumentDiagnosticReportResult>

The textDocument/diagnostic request is sent from the client to the server to ask the server to compute the diagnostics for a given document.

async fn workspace_diagnostic( &self, params: WorkspaceDiagnosticParams, ) -> Result<WorkspaceDiagnosticReportResult>

The workspace/diagnostic request is sent from the client to the server to ask the server to compute workspace wide diagnostics which previously where pushed from the server to the client.

async fn code_action( &self, params: CodeActionParams, ) -> Result<Option<CodeActionResponse>>

The textDocument/codeAction request is sent from the client to the server to compute commands for a given text document and range. These commands are typically code fixes to either fix problems or to beautify/refactor code.

async fn code_action_resolve(&self, item: CodeAction) -> Result<CodeAction>

The codeAction/resolve request is sent from the client to the server to resolve additional information for a given code action.

fn notebook_did_open( &self, params: DidOpenNotebookDocumentParams, ) -> impl Future<Output = ()> + Send

The notebookDocument/didOpen notification is sent from the client to the server when a new notebook document is opened. It is only sent for notebooks selected by the notebookDocumentSync server capability.

fn notebook_did_change( &self, params: DidChangeNotebookDocumentParams, ) -> impl Future<Output = ()> + Send

The notebookDocument/didChange notification is sent from the client to the server when a notebook document changes. It is only sent for notebooks selected by the notebookDocumentSync server capability.

fn notebook_did_save( &self, params: DidSaveNotebookDocumentParams, ) -> impl Future<Output = ()> + Send

The notebookDocument/didSave notification is sent from the client to the server when a notebook document is saved. It is only sent for notebooks selected by the notebookDocumentSync server capability.

fn notebook_did_close( &self, params: DidCloseNotebookDocumentParams, ) -> impl Future<Output = ()> + Send

The notebookDocument/didClose notification is sent from the client to the server when a notebook document is closed. It is only sent for notebooks selected by the notebookDocumentSync server capability.

fn document_color( &self, params: DocumentColorParams, ) -> impl Future<Output = Result<Vec<ColorInformation>, Error>> + Send

The textDocument/documentColor request is sent from the client to the server to list all color references found in a given text document. Along with the range, a color value in RGB is returned.

fn color_presentation( &self, params: ColorPresentationParams, ) -> impl Future<Output = Result<Vec<ColorPresentation>, Error>> + Send

The textDocument/colorPresentation request is sent from the client to the server to obtain a list of presentations for a color value at a given location.