Skip to main content

LspClient

Struct LspClient 

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

Manages an LSP language server subprocess and communicates via JSON-RPC 2.0.

Uses RefCell<LspClientInner> for interior mutability so that the Analyzer trait’s &self methods can perform LSP I/O without needing &mut self.

Lifecycle:

  1. new() — locate or download the server binary, spawn it, perform LSP initialize.
  2. notify_did_open() / notify_did_change() / notify_did_close() — keep LSP in sync.
  3. find_references_for_symbol() — query cross-file references via textDocument/references.
  4. Drop — send shutdown, then kill the subprocess.

Implementations§

Source§

impl LspClient

Source

pub fn new(project_root: &Path, config: &dyn LspServerConfig) -> Self

Source

pub fn notify_did_open(&self, file_path: &Path, text: &str)

Source

pub fn notify_did_change(&self, file_path: &Path, version: i32, text: &str)

Source

pub fn notify_did_close(&self, file_path: &Path)

Source

pub fn find_references_for_symbol( &self, file_path: &Path, line: usize, character: usize, project_root: &Path, ) -> Vec<PropagationResult>

Trait Implementations§

Source§

impl Analyzer for LspClient

Source§

fn find_references_for_symbol( &self, file_path: &Path, line: usize, character: usize, project_root: &Path, ) -> Vec<PropagationResult>

Find all references to the symbol at the given position in the file. Read more
Source§

fn notify_did_open(&self, file_path: &Path, text: &str)

Notify the language server that a file was opened.
Source§

fn notify_did_change(&self, file_path: &Path, version: i32, text: &str)

Notify the language server that a file was modified (full sync).
Source§

fn notify_did_close(&self, file_path: &Path)

Notify the language server that a file was closed.
Source§

fn is_initialized(&self) -> bool

Whether the analyzer is available and initialized.
Source§

impl Drop for LspClient

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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