Class HostExecuteParams

Namespace

RDCore.SDK.Platform.Protocol

Assembly

RDCore.SDK.dll

Request for rdcore/host/execute: the language-server side of ExecuteSessionParams, addressed to the component that owns the runtime session.

[Method("rdcore/host/execute", Direction.ClientToServer)]
public record HostExecuteParams : IRequest, IRequest<Unit>, IRequest<ExecuteSessionResult>, IBaseRequest, IEquatable<HostExecuteParams>

Inheritance

object

HostExecuteParams

Implements

IRequest

IRequest<Unit>

IRequest<ExecuteSessionResult>

IBaseRequest

IEquatable<HostExecuteParams>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The parsed module rides a System.Text.Json string for the same reason DiagnoseDocumentRequest's does — the AST is polymorphic and the JSON-RPC transport's own serializer cannot round-trip it (see PlatformJson). The language server has already parsed and defined the module's symbols by the time it sends this, so the host lowers and runs rather than re-deriving any of it.

Properties

Debug

Whether the program runs under a debugger. See Debug.

public bool Debug { get; init; }

Property Value

bool

EntryPoint

The name of the parameterless procedure to invoke.

public string EntryPoint { get; init; }

Property Value

string

Immediate

Whether the entry point is a statement typed at a prompt. See Immediate.

public bool Immediate { get; init; }

Property Value

bool

Json

The System.Text.Json representation of a HostExecutePayload.

public string Json { get; init; }

Property Value

string

ModuleName

The module's programmatic name — the scope EntryPoint is resolved in.

public string ModuleName { get; init; }

Property Value

string

StreamOutput

Whether the lines the program prints are said as they are printed (HostOutputNotification) instead of with the answer, for the whole of the run: the requests that resume the program too. Only a program run under a debugger streams.

public bool StreamOutput { get; init; }

Property Value

bool