Foundry.LspClient

g Foundry.Contextual Foundry.Contextual Foundry.LspClient Foundry.LspClient Foundry.Contextual->Foundry.LspClient GObject.GInterface GObject.GInterface Json.Serializable Json.Serializable GObject.GInterface->Json.Serializable GObject.Object GObject.Object GObject.Object->Foundry.Contextual Json.Serializable->Foundry.Contextual

Subclasses:

None

Methods

Inherited:

Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)

Structs:

GObject.ObjectClass (5)

class

new (context, stream, subprocess)

class

new_with_provider (context, stream, subprocess, provider)

await_ ()

call (method, params)

notify (method, params)

query_capabilities ()

supports_language (language_id)

Virtual Methods

Inherited:

GObject.Object (7), Json.Serializable (5)

Properties

Inherited:

Foundry.Contextual (1)

Name

Type

Flags

Short Description

io-stream

Gio.IOStream

w/co

provider

Foundry.LspProvider

r/w/co

subprocess

Gio.Subprocess

r/w/co

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Foundry.LspClient(**kwargs)
Bases:

Foundry.Contextual

Abstract:

No

Structure:

Foundry.LspClientClass

classmethod new(context, stream, subprocess)
Parameters:
Return type:

Dex.Future

classmethod new_with_provider(context, stream, subprocess, provider)
Parameters:
Return type:

Dex.Future

await_()
Returns:

a [class`Dex`.Future] that resolves when the subprocess has exited or rejects with error.

Return type:

Dex.Future

Await completion of the client subprocess.

call(method, params)
Parameters:
  • method (str) – the method name to call

  • params (Json.Node or None) – parameters for the method call

Returns:

a [class`Dex`.Future] that resolves when a reply is received for the method call.

Return type:

Dex.Future

If params is floating, the reference will be consumed.

notify(method, params)
Parameters:
  • method (str) – the method name to call

  • params (Json.Node or None) – parameters for the notification

Returns:

a [class`Dex`.Future] that resolves when the notification has been sent.

Return type:

Dex.Future

If params is floating, the reference will be consumed.

query_capabilities()
Returns:

a [class`Dex`.Future] that resolves when the query completes or fails.

Return type:

Dex.Future

Queries the servers capabilities.

supports_language(language_id)
Parameters:

language_id (str) –

Return type:

bool

Property Details

Foundry.LspClient.props.io_stream
Name:

io-stream

Type:

Gio.IOStream

Default Value:

None

Flags:

WRITABLE, CONSTRUCT_ONLY

Foundry.LspClient.props.provider
Name:

provider

Type:

Foundry.LspProvider

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

Foundry.LspClient.props.subprocess
Name:

subprocess

Type:

Gio.Subprocess

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY