Struct ClientSocket

pub struct ClientSocket(/* private fields */);

The socket for Language Server to communicate with the Language Client peer.

Implementations

impl ClientSocket

pub fn new_closed() -> Self

Create a closed socket outside a main loop. Any interaction will immediately return an error of Error::ServiceStopped.

This works as a placeholder where a socket is required but actually unused.

Note

To prevent accidental misusages, this method is NOT implemented as Default::default intentionally.

pub async fn request<R: Request>(&self, params: R::Params) -> Result<R::Result>

Send a request to the peer and wait for its response.

Errors

• Error::ServiceStopped when the service main loop stopped.
• Error::Response when the peer replies an error.

pub fn notify<N: Notification>(&self, params: N::Params) -> Result<()>

Send a notification to the peer and wait for its response.

This is done asynchronously. An Ok result indicates the message is successfully queued, but may not be sent to the peer yet.

Errors

• Error::ServiceStopped when the service main loop stopped.

pub fn emit<E: Send + 'static>(&self, event: E) -> Result<()>

Emit an arbitrary loopback event object to the service handler.

This is done asynchronously. An Ok result indicates the message is successfully queued, but may not be processed yet.

Errors

• Error::ServiceStopped when the service main loop stopped.

Trait Implementations

impl Clone for ClientSocket

fn clone(&self) -> ClientSocket

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientSocket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl LanguageClient for &ClientSocket

type Error = Error

Should always be defined to ResponseError for user implementations.

type NotifyResult = Result<(), Error>

Should always be defined to ControlFlow<Result<()>> for user implementations.

fn workspace_folders( &mut self, params: <WorkspaceFoldersRequest as Request>::Params, ) -> BoxFuture<'static, Result<<WorkspaceFoldersRequest as Request>::Result, Self::Error>>

fn configuration( &mut self, params: <WorkspaceConfiguration as Request>::Params, ) -> BoxFuture<'static, Result<<WorkspaceConfiguration as Request>::Result, Self::Error>>

fn work_done_progress_create( &mut self, params: <WorkDoneProgressCreate as Request>::Params, ) -> BoxFuture<'static, Result<<WorkDoneProgressCreate as Request>::Result, Self::Error>>

fn semantic_tokens_refresh( &mut self, params: <SemanticTokensRefresh as Request>::Params, ) -> BoxFuture<'static, Result<<SemanticTokensRefresh as Request>::Result, Self::Error>>

fn show_document( &mut self, params: <ShowDocument as Request>::Params, ) -> BoxFuture<'static, Result<<ShowDocument as Request>::Result, Self::Error>>

fn inline_value_refresh( &mut self, params: <InlineValueRefreshRequest as Request>::Params, ) -> BoxFuture<'static, Result<<InlineValueRefreshRequest as Request>::Result, Self::Error>>

fn inlay_hint_refresh( &mut self, params: <InlayHintRefreshRequest as Request>::Params, ) -> BoxFuture<'static, Result<<InlayHintRefreshRequest as Request>::Result, Self::Error>>

fn workspace_diagnostic_refresh( &mut self, params: <WorkspaceDiagnosticRefresh as Request>::Params, ) -> BoxFuture<'static, Result<<WorkspaceDiagnosticRefresh as Request>::Result, Self::Error>>

fn register_capability( &mut self, params: <RegisterCapability as Request>::Params, ) -> BoxFuture<'static, Result<<RegisterCapability as Request>::Result, Self::Error>>

fn unregister_capability( &mut self, params: <UnregisterCapability as Request>::Params, ) -> BoxFuture<'static, Result<<UnregisterCapability as Request>::Result, Self::Error>>

fn show_message_request( &mut self, params: <ShowMessageRequest as Request>::Params, ) -> BoxFuture<'static, Result<<ShowMessageRequest as Request>::Result, Self::Error>>

fn code_lens_refresh( &mut self, params: <CodeLensRefresh as Request>::Params, ) -> BoxFuture<'static, Result<<CodeLensRefresh as Request>::Result, Self::Error>>

fn apply_edit( &mut self, params: <ApplyWorkspaceEdit as Request>::Params, ) -> BoxFuture<'static, Result<<ApplyWorkspaceEdit as Request>::Result, Self::Error>>

fn show_message( &mut self, params: <ShowMessage as Notification>::Params, ) -> Self::NotifyResult

fn log_message( &mut self, params: <LogMessage as Notification>::Params, ) -> Self::NotifyResult

fn telemetry_event( &mut self, params: <TelemetryEvent as Notification>::Params, ) -> Self::NotifyResult

fn publish_diagnostics( &mut self, params: <PublishDiagnostics as Notification>::Params, ) -> Self::NotifyResult

fn log_trace( &mut self, params: <LogTrace as Notification>::Params, ) -> Self::NotifyResult

fn cancel_request( &mut self, params: <Cancel as Notification>::Params, ) -> Self::NotifyResult

fn progress( &mut self, params: <Progress as Notification>::Params, ) -> Self::NotifyResult

impl LanguageClient for ClientSocket

type Error = Error

Should always be defined to ResponseError for user implementations.

type NotifyResult = Result<(), Error>

Should always be defined to ControlFlow<Result<()>> for user implementations.

fn workspace_folders( &mut self, params: <WorkspaceFoldersRequest as Request>::Params, ) -> BoxFuture<'static, Result<<WorkspaceFoldersRequest as Request>::Result, Self::Error>>

fn configuration( &mut self, params: <WorkspaceConfiguration as Request>::Params, ) -> BoxFuture<'static, Result<<WorkspaceConfiguration as Request>::Result, Self::Error>>

fn work_done_progress_create( &mut self, params: <WorkDoneProgressCreate as Request>::Params, ) -> BoxFuture<'static, Result<<WorkDoneProgressCreate as Request>::Result, Self::Error>>

fn semantic_tokens_refresh( &mut self, params: <SemanticTokensRefresh as Request>::Params, ) -> BoxFuture<'static, Result<<SemanticTokensRefresh as Request>::Result, Self::Error>>

fn show_document( &mut self, params: <ShowDocument as Request>::Params, ) -> BoxFuture<'static, Result<<ShowDocument as Request>::Result, Self::Error>>

fn inline_value_refresh( &mut self, params: <InlineValueRefreshRequest as Request>::Params, ) -> BoxFuture<'static, Result<<InlineValueRefreshRequest as Request>::Result, Self::Error>>

fn inlay_hint_refresh( &mut self, params: <InlayHintRefreshRequest as Request>::Params, ) -> BoxFuture<'static, Result<<InlayHintRefreshRequest as Request>::Result, Self::Error>>

fn workspace_diagnostic_refresh( &mut self, params: <WorkspaceDiagnosticRefresh as Request>::Params, ) -> BoxFuture<'static, Result<<WorkspaceDiagnosticRefresh as Request>::Result, Self::Error>>

fn register_capability( &mut self, params: <RegisterCapability as Request>::Params, ) -> BoxFuture<'static, Result<<RegisterCapability as Request>::Result, Self::Error>>

fn unregister_capability( &mut self, params: <UnregisterCapability as Request>::Params, ) -> BoxFuture<'static, Result<<UnregisterCapability as Request>::Result, Self::Error>>

fn show_message_request( &mut self, params: <ShowMessageRequest as Request>::Params, ) -> BoxFuture<'static, Result<<ShowMessageRequest as Request>::Result, Self::Error>>

fn code_lens_refresh( &mut self, params: <CodeLensRefresh as Request>::Params, ) -> BoxFuture<'static, Result<<CodeLensRefresh as Request>::Result, Self::Error>>

fn apply_edit( &mut self, params: <ApplyWorkspaceEdit as Request>::Params, ) -> BoxFuture<'static, Result<<ApplyWorkspaceEdit as Request>::Result, Self::Error>>

fn show_message( &mut self, params: <ShowMessage as Notification>::Params, ) -> Self::NotifyResult

fn log_message( &mut self, params: <LogMessage as Notification>::Params, ) -> Self::NotifyResult

fn telemetry_event( &mut self, params: <TelemetryEvent as Notification>::Params, ) -> Self::NotifyResult

fn publish_diagnostics( &mut self, params: <PublishDiagnostics as Notification>::Params, ) -> Self::NotifyResult

fn log_trace( &mut self, params: <LogTrace as Notification>::Params, ) -> Self::NotifyResult

fn cancel_request( &mut self, params: <Cancel as Notification>::Params, ) -> Self::NotifyResult

fn progress( &mut self, params: <Progress as Notification>::Params, ) -> Self::NotifyResult

impl LspService for ClientSocket

Available on crate feature forward only.

fn notify(&mut self, notif: AnyNotification) -> ControlFlow<Result<()>>

The handler of LSP notifications.

fn emit(&mut self, event: AnyEvent) -> ControlFlow<Result<()>>

The handler of an arbitrary AnyEvent.

impl Service<AnyRequest> for ClientSocket

Available on crate feature forward only.

type Response = Value

Responses given by the service.

type Error = ResponseError

Errors produced by the service.

type Future = PeerSocketResponseFuture

The future response value.

fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, req: AnyRequest) -> Self::Future

Process the request and return the response asynchronously.