DartLaunchRequestArguments class

An implementation of LaunchRequestArguments 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 launchRequest, which is a request to start debugging an application.

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

Inheritance
Implemented types

Constructors

DartLaunchRequestArguments({bool? noDebug, required String program, List<String>? args, int? vmServicePort, List<String>? toolArgs, List<String>? vmAdditionalArgs, String? console, String? customTool, int? customToolReplacesArgs, Object? restart, String? name, String? cwd, Map<String, String>? env, List<String>? additionalProjectPaths, bool? debugSdkLibraries, bool? debugExternalPackageLibraries, bool? showGettersInDebugViews, bool? evaluateGettersInDebugViews, bool? evaluateToStringInDebugViews, bool? sendLogsToClient, bool? sendCustomProgressEvents = null, bool? allowAnsiColorOutput})
DartLaunchRequestArguments.fromMap(Map<String, Object?> obj)

Properties

additionalProjectPaths → List<String>?
Paths that should be considered the users local code.
finalinherited
allowAnsiColorOutput → bool?
Whether to allow ansi color codes in OutputEvents. These may be used to highlight user code in stack traces.
finalinherited
args → List<String>?
Arguments to be passed to program.
final
console → String?
Which console to run the program in.
final
customTool → String?
An optional tool to run instead of "dart".
final
customToolReplacesArgs → int?
The number of arguments to delete from the beginning of the argument list when invoking customTool.
final
cwd → String?
finalinherited
debugExternalPackageLibraries → bool?
Whether external package libraries should be marked as debuggable.
finalinherited
debugSdkLibraries → bool?
Whether SDK libraries should be marked as debuggable.
finalinherited
env → Map<String, String>?
Environment variables to pass to the launched process.
finalinherited
evaluateGettersInDebugViews → bool?
Whether to eagerly evaluate getters in debug views like hovers and the variables list.
finalinherited
evaluateToStringInDebugViews → bool?
Whether to call toString() on objects in debug views like hovers and the variables list.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
name → String?
finalinherited
noDebug → bool?
If noDebug is true the launch request should launch the program without enabling debugging.
final
program → String
The program/Dart script to be run.
final
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.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sendCustomProgressEvents → bool?
Whether to send custom progress events for long-running operations.
finalinherited
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.
finalinherited
showGettersInDebugViews → bool?
Whether to show getters in debug views like hovers and the variables list.
finalinherited
toolArgs → List<String>?
Arguments to be passed to the tool that will run program (for example, the VM or Flutter tool).
final
vmAdditionalArgs → List<String>?
Arguments to be passed directly to the Dart VM that will run program.
final
vmServicePort → int?
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) → DartLaunchRequestArguments
override