Struct LsDriver

pub struct LsDriver<M, Args: Initializer> {
    pub client: LspClient,
    pub events: HashMap<TypeId, Box<dyn for<'a> Fn(ServiceState<'a, Args, Args::S>, &LspClient, Event) -> Result<()>>>,
    pub commands: HashMap<&'static str, Box<dyn Fn(&mut Args::S, Vec<Value>) -> SchedulableResponse<Value>>>,
    pub notifications: HashMap<&'static str, Box<dyn Fn(&mut Args::S, Value) -> LspResult<()>>>,
    pub requests: HashMap<&'static str, Box<dyn Fn(&mut Args::S, Value) -> SchedulableResponse<Value>>>,
    pub resources: HashMap<Arc<Path>, Box<dyn Fn(&mut Args::S, Vec<Value>) -> SchedulableResponse<Value>>>,
    /* private fields */
}

The language server driver.

Fields

client: LspClient

The language server client.

events: HashMap<TypeId, Box<dyn for<'a> Fn(ServiceState<'a, Args, Args::S>, &LspClient, Event) -> Result<()>>>

Events for dispatching.

commands: HashMap<&'static str, Box<dyn Fn(&mut Args::S, Vec<Value>) -> SchedulableResponse<Value>>>

Extra commands provided with textDocument/executeCommand.

notifications: HashMap<&'static str, Box<dyn Fn(&mut Args::S, Value) -> LspResult<()>>>

Notifications for dispatching.

requests: HashMap<&'static str, Box<dyn Fn(&mut Args::S, Value) -> SchedulableResponse<Value>>>

Requests for dispatching.

resources: HashMap<Arc<Path>, Box<dyn Fn(&mut Args::S, Vec<Value>) -> SchedulableResponse<Value>>>

Resources for dispatching.

Implementations

impl<Args: Initializer> LsDriver<DapMessage, Args>

where Args::S: 'static,

pub fn start( &mut self, inbox: TConnectionRx<DapMessage>, is_replay: bool, ) -> Result<()>

Starts the debug adaptor on the given connection.

If is_replay is true, the server will wait for all pending requests to finish before exiting. This is useful for testing the language server.

See transport::MirrorArgs for information about the record-replay feature.

pub fn start_(&mut self, inbox: TConnectionRx<DapMessage>) -> Result<()>

Starts the debug adaptor on the given connection.

impl<Args: Initializer> LsDriver<LspMessage, Args>

where Args::S: 'static,

pub fn start( &mut self, inbox: TConnectionRx<LspMessage>, is_replay: bool, ) -> Result<()>

Starts the language server on the given connection.

If is_replay is true, the server will wait for all pending requests to finish before exiting. This is useful for testing the language server.

See transport::MirrorArgs for information about the record-replay feature.

pub fn start_(&mut self, inbox: TConnectionRx<LspMessage>) -> Result<()>

Starts the language server on the given connection.

pub fn on_server_event(&mut self, event_id: u32)

Handles an incoming server event.

pub fn on_lsp_request( &mut self, method: &str, params: JsonValue, ) -> ScheduleResult

Registers and handles a request. This should only be called once per incoming request.

pub fn on_notification( &mut self, method: &str, params: JsonValue, ) -> LspResult<()>

Handles an incoming notification.

pub fn on_lsp_response(&mut self, resp: Response)

Handles an incoming response.

impl<M, Args: Initializer> LsDriver<M, Args>

pub fn state(&self) -> Option<&Args::S>

Gets the state of the language server.

pub fn state_mut(&mut self) -> Option<&mut Args::S>

Gets the mutable state of the language server.

pub fn ready(&mut self, params: Args::I) -> AnySchedulableResponse

Makes the language server ready.

pub fn get_resources(&mut self, args: Vec<JsonValue>) -> ScheduleResult

Get static resources with help of tinymist service, for example, a static help pages for some typst function.