Skip to main content

LspEvent

Enum LspEvent 

Source
pub enum LspEvent {
    Hover {
        text: String,
    },
    Completion {
        items: Vec<String>,
    },
    Definition {
        uri: String,
        range: LspRange,
    },
    Formatting {
        uri: String,
        edits: Vec<LspTextChange>,
    },
    Progress {
        token: String,
        server_key: String,
        title: String,
        message: Option<String>,
        percentage: Option<u32>,
        done: bool,
    },
    Log {
        server_key: String,
        message: String,
    },
}
Expand description

Events that can be sent from the LSP client to the application.

Receive these by polling the mpsc::Receiver you pass to LspProcessClient::new_with_server. Requests are fire-and-forget, so every server reply arrives here rather than as a return value — drain the receiver on a timer and fold the results into the application state.

§Examples

use std::sync::mpsc;

use iced_code_editor::{LspEvent, LSP_EVENT_QUEUE_CAPACITY};

// Bounded: the queue is fed by a language server, so it needs a ceiling.
let (tx, rx) = mpsc::sync_channel::<LspEvent>(LSP_EVENT_QUEUE_CAPACITY);
tx.send(LspEvent::Hover { text: "fn main()".to_string() })
    .expect("the receiver is still alive");

// Drain everything queued since the last tick.
while let Ok(event) = rx.try_recv() {
    match event {
        LspEvent::Hover { text } => assert_eq!(text, "fn main()"),
        LspEvent::Completion { items } => drop(items),
        LspEvent::Definition { uri, .. } => drop(uri),
        LspEvent::Formatting { edits, .. } => drop(edits),
        LspEvent::Progress { done, .. } => drop(done),
        LspEvent::Log { message, .. } => drop(message),
    }
}

Variants§

§

Hover

Hover information received from the LSP server.

Fields

§text: String

Markdown or plain-text hover content.

§

Completion

Completion items received from the LSP server.

Fields

§items: Vec<String>

List of completion label strings.

§

Definition

Definition location received from the LSP server.

Fields

§uri: String

Target document URI.

§range: LspRange

Target range within that document.

§

Formatting

Formatting edits received from the LSP server.

Fields

§uri: String

URI of the document the edits apply to.

§edits: Vec<LspTextChange>

Edits to apply, in the document’s own character coordinates.

Apply them with CodeEditor::apply_lsp_text_edits, which takes care of ordering and of landing them as a single undo step.

§

Progress

Progress notification from the LSP server.

Fields

§token: String

Progress token identifier.

§server_key: String

Key of the server that sent this notification.

§title: String

Human-readable title for the progress operation.

§message: Option<String>

Optional status message.

§percentage: Option<u32>

Optional percentage complete (0–100).

§done: bool

true when this is the final progress notification.

§

Log

Log message from the LSP server’s stderr.

Fields

§server_key: String

Key of the server that sent this message.

§message: String

The log line.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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<State, Message> IntoBoot<State, Message> for State

Source§

fn into_boot(self) -> (State, Task<Message>)

Turns some type into the initial state of some Application.
Source§

impl<T> MaybeClone for T

Source§

impl<T> MaybeDebug for T

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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