Crate dap_types

Source

Expand description

Debugger Adapter Protocol types for Rust.

Based on: https://microsoft.github.io/debug-adapter-protocol/specification (generated from machine-readable schema).

Modules§

events: Types representing events, with associated payload types.
messages: Types representing protocol messages.
requests: Types representing requests, with associated argument and response types.

Structs§

AttachRequestArguments
Breakpoint: Information about a breakpoint created in setBreakpoints, setFunctionBreakpoints, setInstructionBreakpoints, or setDataBreakpoints requests.
BreakpointEvent: The event indicates that some information about a breakpoint has changed.
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.
BreakpointMode: A BreakpointMode is provided as a option when setting breakpoints on sources or instructions.
CancelArguments: Arguments for cancel request.
Capabilities: Information about the capabilities of a debug adapter.
CapabilitiesEvent: The event indicates that one or more capabilities have changed. Since the capabilities are dependent on the client and its UI, it might not be possible to change that at random times (or too late). Consequently this event has a hint characteristic: a client can only be expected to make a ‘best effort’ in honoring individual capabilities but there are no guarantees. Only changed capabilities need to be included, all other capabilities keep their values.
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.
ConfigurationDoneArguments: Arguments for configurationDone request.
ContinueArguments: Arguments for continue request.
ContinueResponse: Response to continue request.
ContinuedEvent: The event indicates that the execution of the debuggee has continued. Please note: a debug adapter is not expected to send this event in response to a request that implies that execution continues, e.g. launch or continue. It is only necessary to send a continued event if there was no previous request that implied this.
DataBreakpoint: Properties of a data breakpoint passed to the setDataBreakpoints request.
DataBreakpointInfoArguments: Arguments for dataBreakpointInfo request.
DataBreakpointInfoResponse: Response to dataBreakpointInfo request.
DisassembleArguments: Arguments for disassemble request.
DisassembleResponse: Response to disassemble request.
DisassembledInstruction: Represents a single disassembled instruction.
DisconnectArguments: Arguments for disconnect request.
EvaluateArguments: Arguments for evaluate request.
EvaluateResponse: Response to evaluate request.
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.
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.
ExitedEvent: The event indicates that the debuggee has exited and returns its exit code.
FunctionBreakpoint: Properties of a breakpoint passed to the setFunctionBreakpoints request.
GotoArguments: Arguments for goto request.
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.
InitializeRequestArguments: Arguments for initialize request.
InstructionBreakpoint: Properties of a breakpoint passed to the setInstructionBreakpoints request
InvalidatedEvent: This event signals that some state in the debug adapter has changed and requires that the client needs to re-render the data snapshot previously requested. Debug adapters do not have to emit this event for runtime changes like stopped or thread events because in that case the client refetches the new state anyway. But the event can be used for example to refresh the UI after rendering formatting has changed in the debug adapter. This event should only be sent if the corresponding capability supportsInvalidatedEvent is true.
LaunchRequestArguments
LoadedSourceEvent: The event indicates that some source has been added, changed, or removed from the set of all loaded sources.
LoadedSourcesArguments: Arguments for loadedSources request.
LoadedSourcesResponse: Response to loadedSources request.
MemoryEvent: This event indicates that some memory range has been updated. It should only be sent if the corresponding capability supportsMemoryEvent is true. Clients typically react to the event by re-issuing a readMemory request if they show the memory identified by the memoryReference and if the updated memory range overlaps the displayed range. Clients should not make assumptions how individual memory references relate to each other, so they should not assume that they are part of a single continuous address range and might overlap. Debug adapters can use this event to indicate that the contents of a memory range has changed due to some other request like setVariable or setExpression. Debug adapters are not expected to emit this event for each and every memory change of a running program, because that information is typically not available from debuggers and it would flood clients with too many events.
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.
ModuleEvent: The event indicates that some information about a module has changed.
ModulesArguments: Arguments for modules request.
ModulesResponse: Response to modules request.
NextArguments: Arguments for next request.
OutputEvent: The event indicates that the target has produced some output.
PauseArguments: Arguments for pause request.
ProcessEvent: The event indicates that the debugger has begun debugging a new process. Either one that it has launched, or one that it has attached to.
ProgressEndEvent: The event signals the end of the progress reporting with a final message. This event should only be sent if the corresponding capability supportsProgressReporting is true.
ProgressStartEvent: The event signals that a long running operation is about to start and provides additional information for the client to set up a corresponding progress and cancellation UI. The client is free to delay the showing of the UI in order to reduce flicker. This event should only be sent if the corresponding capability supportsProgressReporting is true.
ProgressUpdateEvent: The event signals that the progress reporting needs to be updated with a new message and/or percentage. The client does not have to update the UI immediately, but the clients needs to keep track of the message and/or percentage values. This event should only be sent if the corresponding capability supportsProgressReporting is true.
ReadMemoryArguments: Arguments for readMemory request.
ReadMemoryResponse: Response to readMemory request.
RestartArguments
RestartFrameArguments: Arguments for restartFrame request.
ReverseContinueArguments: Arguments for reverseContinue request.
RunInTerminalRequestArguments: Arguments for runInTerminal request.
RunInTerminalResponse: Response to runInTerminal request.
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.
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.
SetDataBreakpointsArguments: Arguments for setDataBreakpoints request.
SetDataBreakpointsResponse: Response to setDataBreakpoints request. Returned is information about each breakpoint created by this request.
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 is 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.
SetExpressionArguments: Arguments for setExpression request.
SetExpressionResponse: Response to setExpression request.
SetFunctionBreakpointsArguments: Arguments for setFunctionBreakpoints request.
SetFunctionBreakpointsResponse: Response to setFunctionBreakpoints request. Returned is information about each breakpoint created by this request.
SetInstructionBreakpointsArguments: Arguments for setInstructionBreakpoints request
SetInstructionBreakpointsResponse: Response to setInstructionBreakpoints request
SetVariableArguments: Arguments for setVariable request.
SetVariableResponse: Response to setVariable request.
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.
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.
StartDebuggingRequestArguments: Arguments for startDebugging request.
StepBackArguments: Arguments for stepBack request.
StepInArguments: Arguments for stepIn request.
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.
StepOutArguments: Arguments for stepOut request.
StoppedEvent: The event indicates that the execution of the debuggee has stopped due to some condition. This can be caused by a breakpoint previously set, a stepping request has completed, by executing a debugger statement etc.
TerminateArguments: Arguments for terminate request.
TerminateThreadsArguments: Arguments for terminateThreads request.
TerminatedEvent: The event indicates that debugging of the debuggee has terminated. This does not mean that the debuggee itself has exited.
Thread: A Thread
ThreadEvent: The event indicates that a thread has started or exited.
ThreadsResponse: Response to threads request.
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.
WriteMemoryArguments: Arguments for writeMemory request.
WriteMemoryResponse: Response to writeMemory request.

Enums§

BreakpointEventReason: The reason for the event.
BreakpointModeApplicability: Describes one or more type of breakpoint a BreakpointMode applies to. This is a non-exhaustive enumeration and may expand as future breakpoint types are added.
BreakpointReason: A machine-readable explanation of why a breakpoint may not be verified. If a breakpoint is verified or a specific reason is not known, the adapter should omit this property. Possible values include:
ChecksumAlgorithm: Names of checksum algorithms that may be supported by a debug adapter.
ColumnDescriptorType: Datatype of values in this column. Defaults to string if not specified.
CompletionItemType: Some predefined types for the CompletionItem. Please note that not all clients have specific icons for all of them.
DataBreakpointAccessType: This enumeration defines all possible access types for data breakpoints.
DisassembledInstructionPresentationHint: A hint for how to present the instruction in the UI.
EvaluateArgumentsContext: The context in which the evaluate request is used.
ExceptionBreakMode: 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.
InitializeRequestArgumentsPathFormat: Determines in what format paths are specified. The default is path, which is the native format.
InvalidatedAreas: Logical areas that can be invalidated by the invalidated event.
LoadedSourceEventReason: The reason for the event.
ModuleEventReason: The reason for the event.
ModuleId
OutputEventCategory: The output category. If not specified or if the category is not understood by the client, console is assumed.
OutputEventGroup: Support for keeping an output log organized by grouping related messages.
ProcessEventStartMethod: Describes how the debug engine started debugging this process.
RunInTerminalRequestArgumentsKind: What kind of terminal to launch. Defaults to integrated if not specified.
ScopePresentationHint: A hint for how to present this scope in the UI. If this attribute is missing, the scope is shown with a generic UI.
SourcePresentationHint: A hint for how to present the source in the UI. A value of deemphasize can be used to indicate that the source is not available or that it is skipped on stepping.
StackFramePresentationHint: A hint for how to present this frame in the UI. A value of label can be used to indicate that the frame is an artificial frame that is used as a visual label or separator. A value of subtle can be used to change the appearance of a frame in a ‘subtle’ way.
StartDebuggingRequestArgumentsRequest: Indicates whether the new debug session should be started with a launch or attach request.
SteppingGranularity: The granularity of one ‘step’ in the stepping requests next, stepIn, stepOut, and stepBack.
StoppedEventReason: The reason for the event. For backward compatibility this string is shown in the UI if the description attribute is missing (but it must not be translated).
ThreadEventReason: The reason for the event.
VariablePresentationHintAttributes
VariablePresentationHintKind: The kind of variable. Before introducing additional values, try to use the listed values.
VariablePresentationHintVisibility: Visibility of variable. Before introducing additional values, try to use the listed values.
VariablesArgumentsFilter: Filter to limit the child variables to either named or indexed. If omitted, both types are fetched.

Crate dap_typesCopy item path

Modules§

Structs§

Enums§

Crate dap_types