Connection

Struct Connection 

Source
pub struct Connection {
    pub sender: Sender<Message>,
    pub receiver: Receiver<Message>,
}
Expand description

Connection is just a pair of channels of LSP messages.

Fields§

§sender: Sender<Message>§receiver: Receiver<Message>

Implementations§

Source§

impl Connection

Source

pub fn stdio() -> (Connection, IoThreads)

Create connection over standard in/standard out.

Use this to create a real language server.

Source

pub fn connect<A: ToSocketAddrs>(addr: A) -> Result<(Connection, IoThreads)>

Open a connection over tcp. This call blocks until a connection is established.

Source

pub fn listen<A: ToSocketAddrs>(addr: A) -> Result<(Connection, IoThreads)>

Listen for a connection over tcp. This call blocks until a connection is established.

Source

pub fn memory() -> (Connection, Connection)

Creates a pair of connected connections in memory for testing.

Source

pub fn initialize<V: Serialize>( &self, process: impl FnOnce(&InitializeBuild) -> V, ) -> Result<InitializeBuild, ProtocolError>

Initialize the connection. Sends the server initialize response to the client and returns the serialized client capabilities on success. If more fine-grained initialization is required use initialize_start/initialize_finish.

§Example
use std::error::Error;
use build_server_protocol::types::InitializeBuildResult;
use build_server_protocol::server::{Connection, Message, Request, RequestId, Response};

fn main() -> Result<(), Box<dyn Error + Sync + Send>> {
   // Create the transport
   let (conn, io_threads) = Connection::stdio();

   // Run the server
   conn.initialize(|_params| {
       Ok(InitializeBuildResult::new_simple(
        "MyBuildServer",
        "0.1",
        "2.0",
        ServerCapabilities::default()))
   })?;

   // ... Run main loop ...

   Ok(())
}
Source

pub fn handle_shutdown(&self, req: &Request) -> Result<bool, ProtocolError>

If req is Shutdown, respond to it and return true, otherwise return false

Source

pub fn send<T: Into<Message>>(&self, msg: T) -> Result<(), SendError<Message>>

delegates to self.sender

Source

pub fn try_send<T: Into<Message>>( &self, msg: T, ) -> Result<(), TrySendError<Message>>

delegates to self.sender

Source

pub fn send_timeout<T: Into<Message>>( &self, msg: T, timeout: Duration, ) -> Result<(), SendTimeoutError<Message>>

delegates to self.sender

Source

pub fn send_deadline<T: Into<Message>>( &self, msg: T, deadline: Instant, ) -> Result<(), SendTimeoutError<Message>>

delegates to self.sender

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, 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
Source§

impl<T> ErasedDestructor for T
where T: 'static,