DartAttachRequestArguments class

An implementation of AttachRequestArguments that includes all fields used by the Dart CLI and test debug adapters.

This class represents the data passed from the client editor to the debug adapter in attachRequest, which is a request to start debugging an application.

Specialized adapters (such as Flutter) have their own versions of this class.

Inheritance

• Object
• RequestArguments
• DartCommonLaunchAttachRequestArguments
• DartAttachRequestArguments

Implemented types

• AttachRequestArguments

Constructors

DartAttachRequestArguments({String? vmServiceUri, String? vmServiceInfoFile, Object? restart, String? name, String? cwd, List<String>? additionalProjectPaths, bool? debugSdkLibraries, bool? debugExternalPackageLibraries, bool? showGettersInDebugViews, bool? evaluateGettersInDebugViews, bool? evaluateToStringInDebugViews, bool? sendLogsToClient, bool? sendCustomProgressEvents = null, bool? allowAnsiColorOutput})

DartAttachRequestArguments.fromMap(Map<String, Object?> obj)

Properties

additionalProjectPaths → List<String>?

Paths that should be considered the users local code.

final, inherited

allowAnsiColorOutput → bool?

Whether to allow ansi color codes in OutputEvents. These may be used to highlight user code in stack traces.

final, inherited

cwd → String?

final, inherited

debugExternalPackageLibraries → bool?

Whether external package libraries should be marked as debuggable.

final, inherited

debugSdkLibraries → bool?

Whether SDK libraries should be marked as debuggable.

final, inherited

env → Map<String, String>?

Environment variables to pass to the launched process.

final, inherited

evaluateGettersInDebugViews → bool?

Whether to eagerly evaluate getters in debug views like hovers and the variables list.

final, inherited

evaluateToStringInDebugViews → bool?

Whether to call toString() on objects in debug views like hovers and the variables list.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

name → String?

final, inherited

restart → Object?

Optional data from the previous, restarted session. The data is sent as the 'restart' attribute of the 'terminated' event. The client should leave the data intact.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sendCustomProgressEvents → bool?

Whether to send custom progress events for long-running operations.

final, inherited

sendLogsToClient → bool?

Whether to send debug logging to clients in a custom dart.log event. This is used both by the out-of-process tests to ensure the logs contain enough information to track down issues, but also by Dart-Code to capture VM service traffic in a unified log file.

final, inherited

showGettersInDebugViews → bool?

Whether to show getters in debug views like hovers and the variables list.

final, inherited

vmServiceInfoFile → String?

The VM Service info file to extract the VM Service URI from to attach to.

final

vmServiceUri → String?

The VM Service URI to attach to.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object?>

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

arg → DebugAdapterArgumentReader

A reader for protocol arguments that throws detailed exceptions if arguments aren't of the correct type.

final

Static Methods

fromJson(Map<String, Object?> obj) → DartAttachRequestArguments

override