dap library

Classes

AttachRequestArguments
Arguments for attach request. Additional attributes are implementation specific.
AttachResponse
Response to attach request. This is just an acknowledgement, so no body field is required.
AttachResponseBody
Contains request result if success is true and error details if success is false.
Breakpoint
Information about a breakpoint created in setBreakpoints, setFunctionBreakpoints, setInstructionBreakpoints, or setDataBreakpoints requests.
BreakpointEventBody
BreakpointLocation
Properties of a breakpoint location returned from the breakpointLocations request.
BreakpointLocationsArguments
Arguments for breakpointLocations request.
BreakpointLocationsResponse
Response to breakpointLocations request. Contains possible locations for source breakpoints.
BreakpointLocationsResponseBody
CancelArguments
Arguments for cancel request.
CancelResponse
Response to cancel request. This is just an acknowledgement, so no body field is required.
CancelResponseBody
Contains request result if success is true and error details if success is false.
Capabilities
Information about the capabilities of a debug adapter.
CapabilitiesEventBody
Checksum
The checksum of an item calculated by the specified algorithm.
ColumnDescriptor
A ColumnDescriptor specifies what module attribute to show in a column of the modules view, how to format it, and what the column's label should be. It is only used if the underlying UI actually supports this level of customization.
CompletionItem
CompletionItems are the suggestions returned from the completions request.
CompletionsArguments
Arguments for completions request.
CompletionsResponse
Response to completions request.
CompletionsResponseBody
ConfigurationDoneArguments
Arguments for configurationDone request.
ConfigurationDoneResponse
Response to configurationDone request. This is just an acknowledgement, so no body field is required.
ConfigurationDoneResponseBody
Contains request result if success is true and error details if success is false.
ContinueArguments
Arguments for continue request.
ContinuedEventBody
ContinueResponse
Response to continue request.
ContinueResponseBody
DartInitializeRequestArguments
A custom version of InitializeRequestArguments that adds custom Dart capabilities not covered by the DAP spec.
DataBreakpoint
Properties of a data breakpoint passed to the setDataBreakpoints request.
DataBreakpointInfoArguments
Arguments for dataBreakpointInfo request.
DataBreakpointInfoResponse
Response to dataBreakpointInfo request.
DataBreakpointInfoResponseBody
DebugAdapterArgumentReader
A helper for reading arguments for DAP requests from the client.
DisassembleArguments
Arguments for disassemble request.
DisassembledInstruction
Represents a single disassembled instruction.
DisassembleResponse
Response to disassemble request.
DisassembleResponseBody
DisconnectArguments
Arguments for disconnect request.
DisconnectResponse
Response to disconnect request. This is just an acknowledgement, so no body field is required.
DisconnectResponseBody
Contains request result if success is true and error details if success is false.
Either2<T1, T2>
Represents either a T1 or T2.
ErrorResponse
On error (whenever success is false), the body can provide more details.
ErrorResponseBody
EvaluateArguments
Arguments for evaluate request.
EvaluateResponse
Response to evaluate request.
EvaluateResponseBody
Event
A debug adapter initiated event.
EventBody
A base class for (spec-generated) classes that represent the body of a an event.
ExceptionBreakpointsFilter
An ExceptionBreakpointsFilter is shown in the UI as an filter option for configuring how exceptions are dealt with.
ExceptionDetails
Detailed information about an exception that has occurred.
ExceptionFilterOptions
An ExceptionFilterOptions is used to specify an exception filter together with a condition for the setExceptionBreakpoints request.
ExceptionInfoArguments
Arguments for exceptionInfo request.
ExceptionInfoResponse
Response to exceptionInfo request.
ExceptionInfoResponseBody
ExceptionOptions
An ExceptionOptions assigns configuration options to a set of exceptions.
ExceptionPathSegment
An ExceptionPathSegment represents a segment in a path that is used to match leafs or nodes in a tree of exceptions. If a segment consists of more than one name, it matches the names provided if negate is false or missing, or it matches anything except the names provided if negate is true.
ExitedEventBody
FunctionBreakpoint
Properties of a breakpoint passed to the setFunctionBreakpoints request.
GotoArguments
Arguments for goto request.
GotoResponse
Response to goto request. This is just an acknowledgement, so no body field is required.
GotoResponseBody
Contains request result if success is true and error details if success is false.
GotoTarget
A GotoTarget describes a code location that can be used as a target in the goto request. The possible goto targets can be determined via the gotoTargets request.
GotoTargetsArguments
Arguments for gotoTargets request.
GotoTargetsResponse
Response to gotoTargets request.
GotoTargetsResponseBody
InitializedEventBody
Event-specific information.
InitializeRequestArguments
Arguments for initialize request.
InitializeResponse
Response to initialize request.
InitializeResponseBody
The capabilities of this debug adapter.
InstructionBreakpoint
Properties of a breakpoint passed to the setInstructionBreakpoints request
InvalidatedEventBody
LaunchRequestArguments
Arguments for launch request. Additional attributes are implementation specific.
LaunchResponse
Response to launch request. This is just an acknowledgement, so no body field is required.
LaunchResponseBody
Contains request result if success is true and error details if success is false.
LoadedSourceEventBody
LoadedSourcesArguments
Arguments for loadedSources request.
LoadedSourcesResponse
Response to loadedSources request.
LoadedSourcesResponseBody
MemoryEventBody
Message
A structured message object. Used to return errors from requests.
Module
A Module object represents a row in the modules view. The id attribute identifies a module in the modules view and is used in a module event for identifying a module for adding, updating or deleting. The name attribute is used to minimally render the module in the UI.
ModuleEventBody
ModulesArguments
Arguments for modules request.
ModulesResponse
Response to modules request.
ModulesResponseBody
NextArguments
Arguments for next request.
NextResponse
Response to next request. This is just an acknowledgement, so no body field is required.
NextResponseBody
Contains request result if success is true and error details if success is false.
OutputEventBody
PauseArguments
Arguments for pause request.
PauseResponse
Response to pause request. This is just an acknowledgement, so no body field is required.
PauseResponseBody
Contains request result if success is true and error details if success is false.
ProcessEventBody
ProgressEndEventBody
ProgressStartEventBody
ProgressUpdateEventBody
ProtocolMessage
Base class of requests, responses, and events.
RawEventBody
A generic event body class that just supplies an object directly.
RawRequestArguments
A generic arguments class that just supplies the arguments map directly.
ReadMemoryArguments
Arguments for readMemory request.
ReadMemoryResponse
Response to readMemory request.
ReadMemoryResponseBody
Request
A client or debug adapter initiated request.
RequestArguments
A base class for (spec-generated) classes that represent the arguments of a request.
Response
Response for a request.
RestartArguments
Arguments for restart request.
RestartFrameArguments
Arguments for restartFrame request.
RestartFrameResponse
Response to restartFrame request. This is just an acknowledgement, so no body field is required.
RestartFrameResponseBody
Contains request result if success is true and error details if success is false.
RestartResponse
Response to restart request. This is just an acknowledgement, so no body field is required.
RestartResponseBody
Contains request result if success is true and error details if success is false.
ReverseContinueArguments
Arguments for reverseContinue request.
ReverseContinueResponse
Response to reverseContinue request. This is just an acknowledgement, so no body field is required.
ReverseContinueResponseBody
Contains request result if success is true and error details if success is false.
RunInTerminalRequestArguments
Arguments for runInTerminal request.
RunInTerminalResponse
Response to runInTerminal request.
RunInTerminalResponseBody
Scope
A Scope is a named container for variables. Optionally a scope can map to a source or a range within a source.
ScopesArguments
Arguments for scopes request.
ScopesResponse
Response to scopes request.
ScopesResponseBody
SetBreakpointsArguments
Arguments for setBreakpoints request.
SetBreakpointsResponse
Response to setBreakpoints request. Returned is information about each breakpoint created by this request. This includes the actual code location and whether the breakpoint could be verified. The breakpoints returned are in the same order as the elements of the breakpoints (or the deprecated lines) array in the arguments.
SetBreakpointsResponseBody
SetDataBreakpointsArguments
Arguments for setDataBreakpoints request.
SetDataBreakpointsResponse
Response to setDataBreakpoints request. Returned is information about each breakpoint created by this request.
SetDataBreakpointsResponseBody
SetExceptionBreakpointsArguments
Arguments for setExceptionBreakpoints request.
SetExceptionBreakpointsResponse
Response to setExceptionBreakpoints request. The response contains an array of Breakpoint objects with information about each exception breakpoint or filter. The Breakpoint objects are in the same order as the elements of the filters, filterOptions, exceptionOptions arrays given as arguments. If both filters and filterOptions are given, the returned array must start with filters information first, followed by filterOptions information. The verified property of a Breakpoint object signals whether the exception breakpoint or filter could be successfully created and whether the condition or hit count expressions are valid. In case of an error the message property explains the problem. The id property can be used to introduce a unique ID for the exception breakpoint or filter so that it can be updated subsequently by sending breakpoint events. For backward compatibility both the breakpoints array and the enclosing body are optional. If these elements are missing a client is not able to show problems for individual exception breakpoints or filters.
SetExceptionBreakpointsResponseBody
SetExpressionArguments
Arguments for setExpression request.
SetExpressionResponse
Response to setExpression request.
SetExpressionResponseBody
SetFunctionBreakpointsArguments
Arguments for setFunctionBreakpoints request.
SetFunctionBreakpointsResponse
Response to setFunctionBreakpoints request. Returned is information about each breakpoint created by this request.
SetFunctionBreakpointsResponseBody
SetInstructionBreakpointsArguments
Arguments for setInstructionBreakpoints request
SetInstructionBreakpointsResponse
Response to setInstructionBreakpoints request
SetInstructionBreakpointsResponseBody
SetVariableArguments
Arguments for setVariable request.
SetVariableResponse
Response to setVariable request.
SetVariableResponseBody
Source
A Source is a descriptor for source code. It is returned from the debug adapter as part of a StackFrame and it is used by clients when specifying breakpoints.
SourceArguments
Arguments for source request.
SourceBreakpoint
Properties of a breakpoint or logpoint passed to the setBreakpoints request.
SourceResponse
Response to source request.
SourceResponseBody
StackFrame
A Stackframe contains the source location.
StackFrameFormat
Provides formatting information for a stack frame.
StackTraceArguments
Arguments for stackTrace request.
StackTraceResponse
Response to stackTrace request.
StackTraceResponseBody
StartDebuggingRequestArguments
Arguments for startDebugging request.
StartDebuggingResponse
Response to startDebugging request. This is just an acknowledgement, so no body field is required.
StartDebuggingResponseBody
Contains request result if success is true and error details if success is false.
StepBackArguments
Arguments for stepBack request.
StepBackResponse
Response to stepBack request. This is just an acknowledgement, so no body field is required.
StepBackResponseBody
Contains request result if success is true and error details if success is false.
StepInArguments
Arguments for stepIn request.
StepInResponse
Response to stepIn request. This is just an acknowledgement, so no body field is required.
StepInResponseBody
Contains request result if success is true and error details if success is false.
StepInTarget
A StepInTarget can be used in the stepIn request and determines into which single target the stepIn request should step.
StepInTargetsArguments
Arguments for stepInTargets request.
StepInTargetsResponse
Response to stepInTargets request.
StepInTargetsResponseBody
StepOutArguments
Arguments for stepOut request.
StepOutResponse
Response to stepOut request. This is just an acknowledgement, so no body field is required.
StepOutResponseBody
Contains request result if success is true and error details if success is false.
StoppedEventBody
TerminateArguments
Arguments for terminate request.
TerminatedEventBody
TerminateResponse
Response to terminate request. This is just an acknowledgement, so no body field is required.
TerminateResponseBody
Contains request result if success is true and error details if success is false.
TerminateThreadsArguments
Arguments for terminateThreads request.
TerminateThreadsResponse
Response to terminateThreads request. This is just an acknowledgement, no body field is required.
TerminateThreadsResponseBody
Contains request result if success is true and error details if success is false.
Thread
A Thread
ThreadEventBody
ThreadsResponse
Response to threads request.
ThreadsResponseBody
ToJsonable
An object from the LSP/DAP specs that can be converted to JSON.
ValueFormat
Provides formatting information for a value.
Variable
A Variable is a name/value pair. The type attribute is shown if space permits or when hovering over the variable's name. The kind attribute is used to render additional properties of the variable, e.g. different icons can be used to indicate that a variable is public or private. If the value is structured (has children), a handle is provided to retrieve the children with the variables request. If the number of named or indexed children is large, the numbers should be returned via the namedVariables and indexedVariables attributes. The client can use this information to present the children in a paged UI and fetch them in chunks.
VariablePresentationHint
Properties of a variable that can be used to determine how to render the variable in the UI.
VariablesArguments
Arguments for variables request.
VariablesResponse
Response to variables request.
VariablesResponseBody
WriteMemoryArguments
Arguments for writeMemory request.
WriteMemoryResponse
Response to writeMemory request.
WriteMemoryResponseBody

Constants

commandTypes → const Map<Type, String>
eventTypes → const Map<Type, String>

Functions

specToJson(Object? obj) Object?

Typedefs

ChecksumAlgorithm = String
Names of checksum algorithms that may be supported by a debug adapter.
CompletionItemType = String
Some predefined types for the CompletionItem. Please note that not all clients have specific icons for all of them.
DataBreakpointAccessType = String
This enumeration defines all possible access types for data breakpoints.
ExceptionBreakMode = String
This enumeration defines all possible conditions when a thrown exception should result in a break. never: never breaks, always: always breaks, unhandled: breaks when exception unhandled, userUnhandled: breaks if the exception is not handled by user code.
InvalidatedAreas = String
Logical areas that can be invalidated by the invalidated event.
SteppingGranularity = String
The granularity of one 'step' in the stepping requests next, stepIn, stepOut, and stepBack.

Exceptions / Errors

DebugAdapterException
Exception thrown by a debug adapter when a request is not valid, either because the inputs are not correct or the adapter is not in the correct state.
DebugAdapterInvalidArgumentException
Exception thrown when failing to read arguments supplied by the user because they are not the correct type.