Struct LspHandle 

pub struct LspHandle { /* private fields */ }

Synchronous handle to an async LSP task

Implementations

impl LspHandle

pub fn spawn( runtime: &Handle, command: &str, args: &[String], env: HashMap<String, String>, language: String, async_bridge: &AsyncBridge, process_limits: ProcessLimits, language_id_overrides: HashMap<String, String>, ) -> Result<Self, String>

Spawn a new LSP server in an async task

pub fn id(&self) -> u64

Get the unique ID for this handle instance

pub fn language(&self) -> &str

Get the language this handle serves

pub fn initialize( &self, root_uri: Option<Uri>, initialization_options: Option<Value>, ) -> Result<(), String>

Initialize the server (non-blocking)

This sends the initialize request asynchronously. The server will be ready when is_initialized() returns true. Other methods that require initialization will fail gracefully until then.

The initialization_options are passed to the server during initialization. Some servers like Deno require specific options (e.g., {"enable": true}).

pub fn is_initialized(&self) -> bool

Check if the server is initialized

pub fn state(&self) -> LspClientState

Get the current client state

pub fn did_open( &self, uri: Uri, text: String, language_id: String, ) -> Result<(), String>

Notify document opened

The language_id should match this handle’s language. If it doesn’t, a warning is logged but the notification is still sent (the server will receive it with the specified language_id).

pub fn did_change( &self, uri: Uri, content_changes: Vec<TextDocumentContentChangeEvent>, ) -> Result<(), String>

Notify document changed

pub fn did_close(&self, uri: Uri) -> Result<(), String>

Send didClose notification

pub fn did_save(&self, uri: Uri, text: Option<String>) -> Result<(), String>

Send didSave notification

pub fn add_workspace_folder(&self, uri: Uri, name: String) -> Result<(), String>

Add a workspace folder to the running LSP server

pub fn completion( &self, request_id: u64, uri: Uri, line: u32, character: u32, ) -> Result<(), String>

Request completion at position

pub fn goto_definition( &self, request_id: u64, uri: Uri, line: u32, character: u32, ) -> Result<(), String>

Request go-to-definition

pub fn rename( &self, request_id: u64, uri: Uri, line: u32, character: u32, new_name: String, ) -> Result<(), String>

Request rename

pub fn hover( &self, request_id: u64, uri: Uri, line: u32, character: u32, ) -> Result<(), String>

Request hover documentation

pub fn references( &self, request_id: u64, uri: Uri, line: u32, character: u32, ) -> Result<(), String>

Request find references

pub fn signature_help( &self, request_id: u64, uri: Uri, line: u32, character: u32, ) -> Result<(), String>

Request signature help

pub fn code_actions( &self, request_id: u64, uri: Uri, start_line: u32, start_char: u32, end_line: u32, end_char: u32, diagnostics: Vec<Diagnostic>, ) -> Result<(), String>

Request code actions

pub fn document_diagnostic( &self, request_id: u64, uri: Uri, previous_result_id: Option<String>, ) -> Result<(), String>

Request document diagnostics (pull model)

This sends a textDocument/diagnostic request to fetch diagnostics on demand. Use previous_result_id for incremental updates (server may return unchanged).

pub fn inlay_hints( &self, request_id: u64, uri: Uri, start_line: u32, start_char: u32, end_line: u32, end_char: u32, ) -> Result<(), String>

Request inlay hints for a range (LSP 3.17+)

Inlay hints are virtual text annotations displayed inline (e.g., type hints, parameter names).

pub fn folding_ranges(&self, request_id: u64, uri: Uri) -> Result<(), String>

Request folding ranges for a document

pub fn semantic_tokens_full( &self, request_id: u64, uri: Uri, ) -> Result<(), String>

Request semantic tokens for an entire document

pub fn semantic_tokens_full_delta( &self, request_id: u64, uri: Uri, previous_result_id: String, ) -> Result<(), String>

Request semantic tokens delta for an entire document

pub fn semantic_tokens_range( &self, request_id: u64, uri: Uri, range: Range, ) -> Result<(), String>

Request semantic tokens for a range

pub fn cancel_request(&self, request_id: u64) -> Result<(), String>

Cancel a pending request by its editor request_id

This sends a $/cancelRequest notification to the LSP server. If the request has already completed or doesn’t exist, this is a no-op.

pub fn send_plugin_request( &self, request_id: u64, method: String, params: Option<Value>, ) -> Result<(), String>

Send a custom LSP request initiated by a plugin

pub fn shutdown(&self) -> Result<(), String>

Shutdown the server

Trait Implementations

impl Drop for LspHandle

fn drop(&mut self)

Executes the destructor for this type.