Skip to main content

LspClient

Struct LspClient 

Source
pub struct LspClient { /* private fields */ }
Expand description

Client for connecting to a running LspDaemon over a Unix domain socket.

LspClient is the primary entry point for consumers of this crate. Call connect with a workspace root and language – the client will auto-spawn a daemon process if one isn’t already running, then send an Initialize handshake.

§Connection lifecycle

connect(workspace_root, language)
  → auto-spawn daemon if needed
  → Initialize handshake
  → ready for LSP requests
  → disconnect()

§LSP requests

All requests are forwarded to the underlying language server through the daemon. Each method accepts the same parameters as the corresponding LSP protocol method:

§Diagnostics

§Generic requests

call sends an arbitrary LSP method with typed parameters and response. Use this for LSP methods that don’t have a dedicated wrapper.

§Example

use aether_lspd::{LspClient, LanguageId, path_to_uri};
use std::path::Path;

let client = LspClient::connect(
    Path::new("/home/user/my-project"),
    LanguageId::Rust,
).await?;

let uri = path_to_uri(Path::new("/home/user/my-project/src/main.rs")).unwrap();
let hover = client.hover(uri, 10, 5).await?;

client.disconnect().await?;

Implementations§

Source§

impl LspClient

Source

pub async fn connect( workspace_root: &Path, language: LanguageId, ) -> ClientResult<Self>

Source

pub async fn goto_definition( &self, uri: Uri, line: u32, character: u32, ) -> ClientResult<GotoDefinitionResponse>

Source

pub async fn goto_implementation( &self, uri: Uri, line: u32, character: u32, ) -> ClientResult<GotoDefinitionResponse>

Source

pub async fn find_references( &self, uri: Uri, line: u32, character: u32, include_declaration: bool, ) -> ClientResult<Vec<Location>>

Source

pub async fn hover( &self, uri: Uri, line: u32, character: u32, ) -> ClientResult<Option<Hover>>

Source

pub async fn workspace_symbol( &self, query: String, ) -> ClientResult<Vec<SymbolInformation>>

Source

pub async fn document_symbol( &self, uri: Uri, ) -> ClientResult<DocumentSymbolResponse>

Source

pub async fn prepare_call_hierarchy( &self, uri: Uri, line: u32, character: u32, ) -> ClientResult<Vec<CallHierarchyItem>>

Source

pub async fn incoming_calls( &self, item: CallHierarchyItem, ) -> ClientResult<Vec<CallHierarchyIncomingCall>>

Source

pub async fn outgoing_calls( &self, item: CallHierarchyItem, ) -> ClientResult<Vec<CallHierarchyOutgoingCall>>

Source

pub async fn rename( &self, uri: Uri, line: u32, character: u32, new_name: String, ) -> ClientResult<Option<WorkspaceEdit>>

Source

pub async fn get_diagnostics( &self, uri: Option<Uri>, ) -> ClientResult<Vec<PublishDiagnosticsParams>>

Source

pub async fn queue_diagnostic_refresh(&self, uri: Uri) -> ClientResult<()>

Source

pub async fn disconnect(self) -> ClientResult<()>

Source

pub async fn call<P: Serialize, R: DeserializeOwned>( &self, method: &str, params: &P, default: impl FnOnce() -> R, ) -> ClientResult<R>

Trait Implementations§

Source§

impl Drop for LspClient

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more