ds_tools_general library

Classes

AlertBlockSyntax
Parses GitHub Alerts blocks.
Allocator
Collects references and automatically allocates prefixes and imports.
AppConnection
A connection between the application loaded in the browser and DWDS.
AppMetadata
Metadata for the connected app.
AssetReader
A reader for Dart sources and related source maps.
AsyncBenchmarkBase
AsyncTimeTracker
Track all async execution as disjoint time slices in ascending order.
AsyncWorkerConnection
AsyncWorkerLoop
Persistent Bazel worker loop.
AuthorizationCodeGrant
A class for obtaining credentials via an authorization code grant.
AutolinkExtensionSyntax
Matches autolinks like http://foo.com and foo@bar.com.
AutolinkSyntax
Matches autolinks like <http://foo.com>.
AvailableCachedCpuSamples
A collection of UserTag names associated with caches of CPU samples.
BenchmarkBase
BinaryExpression
Represents two expressions (left and right) and an operator.
Block
Represents blocks of statements of Dart code.
BlockBuilder
BlockParser
Maintains the internal state needed to parse a series of lines into blocks of Markdown suitable for further inline parsing.
BlockquoteSyntax
Parses email-style blockquotes: > quote.
BlockSyntax
BooleanSelector
A boolean expression that evaluates to true or false based on certain inputs.
BoolResponse
A DTD response that indicates success and contains a single boolean value.
BuildRunnerRequireStrategyProvider
Provides a RequireStrategy suitable for use with package:build_runner.
BuildSettings
App build settings.
CachedCpuSamples
An extension of CpuSamples which represents a set of cached samples, associated with a particular UserTag name.
CallInfo
Represents the information for a call site.
Chain
A chain of stack traces.
ChangeType
Enum for what kind of change has happened to a file.
Chrome
Manager for an instance of Chrome.
Class
ClassBuilder
Client
An OAuth2 client.
ClientName
A simple object representing the name of a DDS client.
Clock
A provider for the "current time" and points relative to the current time.
Code
Represents arbitrary Dart code (either expressions or statements).
CodeBlockSyntax
Parses preformatted code blocks that are indented four spaces.
CodeExpression
Represents a Code block as an Expression.
CodeSyntax
Matches backtick-enclosed inline code blocks.
CollectionStyle
An enum of collection styles.
ColorSwatchSyntax
Matches code blocks containing a subset of CSS color syntax.
CompileResult
The result of a compile call.
CompilerOptions
Options passed to DDC and the expression compiler.
Config
A hierarchical configuration.
Constructor
ConstructorBuilder
Credentials
Credentials that prove that a client is allowed to access a resource on the resource owner's behalf.
DartCallInfo
Represents the information for a call site located in Dart source code.
DartDevcFrontendServerClient
Wraps a FrontendServerClient with opinionated web specific functionality, and provides some typical defaults.
DartDevelopmentService
An intermediary between a Dart VM service and its clients that offers additional functionality on top of the standard VM service protocol.
DartEmitter
DartFormatter
A Dart source code formatter.
DartToolingDaemon
A connection to a Dart Tooling Daemon instance.
DdcStrategy
A load strategy for the DDC module system.
DebugConnection
A debug connection between the application in the browser and DWDS.
DebugSettings
Debug settings for the connected app.
DecodeHtmlSyntax
Decodes numeric character references, for example decode &#35; to #.
DelegatingStreamChannel<T>
A simple delegating wrapper around StreamChannel.
Delimiter
A delimiter indicating the possible "open" or possible "close" of a tag for a DelimiterSyntax.
DelimiterRun
An implementation of Delimiter which uses concepts of "left-flanking" and "right-flanking" to determine the values of canOpen and canClose.
DelimiterSyntax
Matches syntax that has a pair of tags and becomes an element, like * for <em>. Allows nested tags.
DelimiterTag
Dependency
Descriptor
A declarative description of a filesystem entry.
DevTools
A server for Dart Devtools.
DevToolsConfiguration
Directive
DirectiveBuilder
Directory
A reference to a directory on the file system.
DirectoryDescriptor
A descriptor describing a directory that may contain nested descriptors.
DirectoryWatcher
Watches the contents of a directory and emits WatchEvents when something in the directory has changed.
Disconnector<T>
Allows the caller to force a channel to disconnect.
Document
Maintains the context needed to parse a Markdown document.
DTDEvent
A Dart Tooling Daemon stream event.
DTDResponse
Represents the response of an RPC call to the Dart Tooling Daemon.
DummyBlockSyntax
Walks the parser forward through the lines does not match any BlockSyntax.
Dwarf
DwarfStackTraceDecoder
A StreamTransformer that scans lines for non-symbolic stack traces.
Dwds
The Dart Web Debug Service.
DwdsEvent
Element
A named tag that can contain other nodes.
EmailAutolinkSyntax
Matches autolinks like <foo@bar.example.com>.
EmojiSyntax
Matches GitHub Markdown emoji syntax like :smile:.
EmphasisSyntax
EmptyBlockSyntax
Entry
An entry in the source map builder.
Enum
EnumBuilder
EnumValue
EnumValueBuilder
EqualsDart
Implementation detail of using the equalsDart matcher.
ErrorCodes
Operating system error codes.
EscapeHtmlSyntax
Encodes ("), (<), (>) and (&).
EscapeSyntax
Escape ASCII punctuation preceded by a backslash.
Expression
Represents a code block that wraps an Expression. Represents a Dart expression.
ExpressionCompilationResult
Result of compilation of dart expression to JavaScript
ExpressionCompiler
Interface to provide means of compiling expressions from dart to JavaScript used to implement expression evaluation in any tools using dwds
ExpressionCompilerService
Service that handles expression compilation requests.
ExpressionEmitter
Knowledge of how to write valid Dart code from ExpressionVisitor.
ExpressionVisitor<T>
Knowledge of different types of expressions in Dart.
Extension
ExtensionBuilder
ExtensionSet
ExtensionSets provide a simple grouping mechanism for common Markdown flavors.
ExtensionType
ExtensionTypeBuilder
FailingTest
A marker annotation used to annotate test methods which are expected to fail.
FencedBlockquoteSyntax
Parses lines fenced by >>> to blockquotes
FencedCodeBlockSyntax
Parses preformatted code blocks between two ~~~ or ``` sequences.
Field
FieldBuilder
File
A reference to a file on the file system.
FileContent
The content of a file from the system where the Dart Tooling Daemon is running.
FileDescriptor
A descriptor describing a single file.
FileLocation
A SourceLocation within a SourceFile.
FileLock
Type of lock when requesting a lock on a file.
FileMode
The modes in which a File can be opened.
FileSpan
A SourceSpan within a SourceFile.
FileStat
The result of calling the POSIX stat() function on a file system object.
FileSystem
A generic representation of a file system.
FileSystemEntity
The common super class for io.File, io.Directory, and io.Link objects.
FileSystemEntityType
The type of an entity on the file system, such as a file, directory, or link.
FileSystemEvent
Base event class emitted by FileSystemEntity.watch.
FileWatcher
Watches a file and emits WatchEvents when the file has changed.
FootnoteDefSyntax
The spec of GFM about footnotes is missing. For online source code of cmark-gfm, see master@c32ef78. A Rust implementation is also available. Footnote definition could contain multiple line-children and children could be separated by one empty line. Its first child-line would be the remaining part of the first line after taking definition leading, combining with other child lines parsed by parseChildLines, is fed into BlockParser.
ForwardingFileSystem
A file system that forwards all methods and properties to a delegate.
ForwardingFileSystemEntity<T extends FileSystemEntity, D extends FileSystemEntity>
A file system entity that forwards all methods and properties to a delegate.
Frame
A single stack frame. Each frame points to a precise location in Dart code.
FrontendServerAssetReader
A reader for Dart sources and related source maps provided by the Frontend Server.
FrontendServerClient
Wrapper around the incremental frontend server compiler.
FrontendServerDdcLibraryBundleStrategyProvider
Provides a DdcLibraryBundleStrategy suitable for use with the Frontend Server.
FrontendServerDdcStrategyProvider
Provides a DdcStrategy suitable for use with Frontend Server.
FrontendServerRequireStrategyProvider
Provides a RequireStrategy suitable for use with Frontend Server.
FunctionType
FunctionTypeBuilder
GitDependency
Glob
A glob for matching and listing files and directories.
GlyphSet
A class that provides access to every configurable glyph.
HeaderSyntax
Parses atx-style headers: ## Header ##.
HeaderWithIdSyntax
Parses atx-style headers, and adds generated IDs to the generated elements.
HorizontalRuleSyntax
Parses horizontal rules like ---, _ _ _, * * *, etc.
HostedDependency
HostedDetails
HtmlBlockSyntax
Parse HTML blocks.
HtmlRenderer
Translates a parsed AST to HTML.
HttpMultiServer
An implementation of dart:io's HttpServer that wraps multiple servers and forwards methods to all of them.
IDEWorkspaceRoots
The list of roots in the IDE workspace.
ImageSyntax
Matches images like ![alternate text](url "optional title") and ![alternate text][label].
InlineHtmlSyntax
Leave inline HTML tags alone, from CommonMark 0.30.
InlineParser
Maintains the internal state needed to parse inline span elements in Markdown.
InlineSyntax
Represents one kind of Markdown tag that can be parsed.
Input
An input file.
InvalidLanguageVersion
An invalid language version.
InvokeExpression
Represents invoking target as a method with arguments.
IOSink
A combined byte and text output.
LanguageVersion
A language version.
Library
LibraryBuilder
Line
A Line is a sequence of zero or more characters other than line feed (U+000A) or carriage return (U+000D), followed by a line ending or by the end of file.
LineBreakSyntax
Represents a hard line break.
LineScanner
A subclass of StringScanner that tracks line and column information.
LineScannerState
A class representing the state of a LineScanner.
A reference to a symbolic link on the file system.
LinkContext
A helper class holds params of link context. Footnote creation needs other info in _tryCreateReferenceLink.
LinkReference
A link reference definition.
LinkReferenceDefinitionSyntax
LinkSyntax
Matches links like [blah][label] and [blah](url).
ListItem
ListSyntax
Base class for both ordered and unordered lists.
LiteralExpression
Represents a literal value in Dart source code.
LiteralListExpression
LoadStrategy
Mapping
A mapping parsed out of a source map.
MappingBundle
MessageGrouper
Interface for a MessageGrouper, which groups bytes in delimited proto format into the bytes for each message.
MetadataProvider
A provider of metadata in which data is collected through DDC outputs.
Method
MethodBuilder
MimeMultipart
A Mime Multipart class representing each part parsed by MimeMultipartTransformer. The data is streamed in as it become available.
MimeMultipartTransformer
Parser for MIME multipart types of data as described in RFC 2046 section 5.1.1. The data is transformed into MimeMultipart objects, each of them streaming the multipart data.
MimeTypeResolver
MIME-type resolver class, used to customize the lookup of mime-types.
Mixin
MixinBuilder
ModuleInfo
MultiChannel<T>
A class that multiplexes multiple virtual channels across a single underlying transport layer.
MultiSectionMapping
A meta-level map containing sections.
NestedItem
An item added to a NestedPrinter.
NestedPrinter
A more advanced printer that keeps track of offset locations to record source maps, but additionally allows nesting of different kind of items, including NestedPrinters, and it let's you automatically indent text.
Node
Base class for any AST item.
NodeVisitor
Visitor pattern for the AST.
NoOpTimeTracker
No-op implementation of SyncTimeTracker that does nothing.
NothingDescriptor
A descriptor that validates that no file exists with the given name.
OrderedListSyntax
Parses ordered lists.
OrderedListWithCheckboxSyntax
Parses ordered lists with checkboxes.
Package
Configuration data for a single package.
PackageConfig
A package configuration.
PackageConfigError
General superclass of most errors and exceptions thrown by this package.
PackageUriMapper
ParagraphSyntax
Parses paragraphs of regular text.
Parameter
ParameterBuilder
ParenthesizedExpression
An Expression wrapped with parenthesis.
PathDependency
PatternDescriptor
A descriptor that matches filesystem entity names by Pattern rather than by exact String.
PCOffset
A program counter address viewed as an offset into the appropriate instructions section of a Dart snapshot. Includes other information parsed from the corresponding stack trace header when possible.
PollingDirectoryWatcher
Periodically polls a directory for changes.
PollingFileWatcher
Periodically polls a file for changes.
Pool
Manages an abstract pool of resources with a limit on how many may be in use at once.
PoolResource
A member of a Pool.
PrintEmitter
PrintEmitterV2
New implementation of PrintEmitter implementing the ScoreEmitterV2 interface. PrintEmitter will be changed to this implementation in the next major version release.
Printer
A simple printer that keeps track of offset locations and records source maps locations.
ProxyServerAssetReader
A reader for resources provided by a proxy server.
Pubspec
RandomAccessFile
Random access to the data in a file.
RecordType
RecordTypeBuilder
Reference
A reference to symbol, such as a class, or top-level method or field.
RepresentationDeclaration
RepresentationDeclarationBuilder
RequireStrategy
A load strategy for the require-js module system.
ResumePermissionsRequired
RpcErrorCodes
ScalarStyle
An enum of source scalar styles.
ScopedCode
Represents a code block that may require scoping.
ScoreEmitter
ScoreEmitterV2
New interface for ScoreEmitter. ScoreEmitter will be changed to this interface in the next major version release, and this class will be deprecated and removed. That release will be a breaking change.
ScratchSpace
An on-disk temporary environment for running executables that don't have a standard Dart library API.
Screenshot
SdkConfiguration
Dart SDK configuration.
SdkConfigurationProvider
SDK configuration provider interface.
SdkDependency
SdkLayout
Dart SDK layout.
SendPortAsyncWorkerConnection
Implementation of AsyncWorkerConnection for running in an isolate.
SetextHeaderSyntax
Parses setext-style headers.
SetextHeaderWithIdSyntax
Parses setext-style headers, and adds generated IDs to the generated elements.
SimpleAsyncTimeTracker
Async actions returning Future will be tracked as single sync time span from the beginning of execution till completion of future
SimpleDelimiter
A simple delimiter implements the Delimiter interface with basic fields, and does not have the concept of "left-flanking" or "right-flanking".
SingleMapping
A map containing direct source mappings.
Size
A simple object representing a size response.
SkippedTest
A marker annotation used to annotate test methods which are skipped.
SocketConnection
An individual (transport-agnostic) bidirectional socket connection.
SocketHandler
A handler that accepts (transport-agnostic) bidirectional socket connections.
SoftLineBreakSyntax
Removes the single space before the line ending.
SourceCode
Describes a chunk of source code that is to be formatted or has been formatted.
SourceEdit
A class representing a change on a String, intended to be compatible with package:analysis_server's SourceEdit.
SourceFile
A class representing a source file.
SourceLocation
A class that describes a single location within a source file.
SourceLocationBase
A base class for source locations with offset, line, and column known at construction time.
SourceLocationMixin
A mixin for easily implementing SourceLocation.
SourceMapBuilder
Builds a source map given a set of mappings.
SourceMapFileSpan
A wrapper aruond a FileSpan that implements SourceMapSpan.
SourceMapSpan
A SourceSpan for spans coming from or being written to source maps.
SourceSpan
A class that describes a segment of source text.
SourceSpanBase
A base class for source spans with start, end, and text known at construction time.
SourceSpanMixin
A mixin for easily implementing SourceSpan.
SourceSpanWithContext
A class that describes a segment of source text with additional context.
SpanScanner
A subclass of LineScanner that exposes matched ranges as source map FileSpans.
Spec
SseClient
A client for bi-directional SSE communication.
SseConnection
A bi-directional SSE connection between server and browser.
SseHandler
SseHandler handles requests on a user defined path to create two-way communications of JSON encodable data between server and clients.
SseSocketConnection
An implementation of SocketConnection that users server-sent events (SSE) and HTTP POSTS for bidirectional communication by wrapping an SseConnection.
SseSocketHandler
An implementation of SocketHandler that accepts server-sent events (SSE) connections and wraps them in an SseSocketConnection.
StackTraceHeader
Header information for a non-symbolic Dart stack trace.
StaticCode
Represents a simple, literal code block to be inserted as-is.
StdAsyncWorkerConnection
Default implementation of AsyncWorkerConnection that works with Stdin and Stdout.
StdSyncWorkerConnection
Default implementation of SyncWorkerConnection that works with Stdin and Stdout.
StreamChannel<T>
An abstract class representing a two-way communication channel.
StreamChannelCompleter<T>
A channel where the source and destination are provided later.
StreamChannelController<T>
A controller for exposing a new StreamChannel.
StreamChannelMixin<T>
A mixin that implements the instance methods of StreamChannel in terms of stream and sink.
StreamChannelTransformer<S, T>
A StreamChannelTransformer transforms the events being passed to and emitted by a StreamChannel.
StreamHistory
A collection of historical Events from some stream.
StrikethroughSyntax
Matches strikethrough syntax according to the GFM spec.
StringListResponse
A DTD response that indicates success and contains a single List of Strings as its value.
StringResponse
A DTD response that indicates success and contains a single String value.
StringScanner
A class that scans through a string using Patterns.
StubCallInfo
Represents the information for a call site located in a Dart stub.
Success
A DTD response that indicates success.
SyncTimeTracker
Tracks only sync actions
SyncWorkerConnection
SyncWorkerLoop
Persistent Bazel worker loop.
TableSyntax
Parses tables.
TagDirective
A directive describing a custom tag handle.
TargetEntry
A target segment entry read from a source map
TargetLineEntry
A line entry read from a source map.
TestProcess
A wrapper for Process that provides a convenient API for testing its standard IO and interacting with it from a test.
TestTimeout
A marker annotation used to annotate test methods with additional timeout information.
Text
A plain text element.
TextEditTransaction
Editable text transaction.
TextSyntax
Matches stuff that should just be passed through as straight text.
TimeSlice
The timings of an operation, including its startTime, stopTime, and duration.
TimeSliceGroup
The timings of an async operation, consist of several sync slices and includes total startTime, stopTime, and duration.
TimeTracker
ToCodeExpression
ToolConfiguration
Configuration about the app, debug settings, and file system.
Trace
A stack trace, comprised of a list of stack frames.
TypeDef
TypeDefBuilder
TypeReference
TypeReferenceBuilder
UnorderedListSyntax
Parses unordered lists.
UnorderedListWithCheckboxSyntax
Parses unordered lists with checkboxes.
UnparsedContent
Inline content that has not been parsed into inline nodes (strong, links, etc).
UnparsedFrame
A frame that failed to parse.
UriList
A list or uris on the system where the Dart Tooling Daemon is running.
Version
A parsed semantic version number.
VersionConstraint
A VersionConstraint is a predicate that can determine whether a given version is valid or not.
VersionDirective
A directive indicating which version of YAML a document was written to.
VersionRange
Constrains versions to a fall within a given range.
VersionUnion
A version constraint representing a union of multiple disjoint version ranges.
VirtualChannel<T>
A virtual channel created by MultiChannel.
Watcher
WatchEvent
An event describing a single change to the file system.
WebSocketChannel
A StreamChannel that communicates over a WebSocket.
WebSocketConnection
An implementation of SocketConnection that uses WebSockets for communication by wrapping WebSocketChannel.
WebSocketSink
The sink exposed by a WebSocketChannel.
WebSocketSocketHandler
An implementation of SocketHandler that accepts WebSocket connections and wraps them in a WebSocketConnection.
WorkerConnection
A connection from a worker to a driver (driver could be bazel, a dart program using BazelWorkerDriver, or any other process that speaks the protocol).
WorkerLoop
Interface for a WorkerLoop.
WorkRequest
This represents a single work unit that Blaze sends to the worker.
WorkResponse
The worker sends this message to Blaze when it finished its work on the WorkRequest message.
YamlDocument
A YAML document, complete with metadata.
YamlEditor
An interface for modifying YAML documents while preserving comments and whitespaces.
YamlList
A read-only List parsed from YAML.
YamlMap
A read-only Map parsed from YAML.
YamlNode
An interface for parsed nodes from a YAML source tree.
YamlScalar
A wrapped scalar value parsed from YAML.

Enums

ClassModifier
DirectiveType
FieldModifier
InstructionsSection
The instructions section in which a program counter address is located.
InvokeExpressionType
MethodModifier
MethodType
ReloadConfiguration
TaskListItemState
TrailingCommas
Configuration for how trailing commas should be handled by the formatter.

Mixins

ForwardingDirectory<T extends Directory>
A directory that forwards all methods and properties to a delegate.
ForwardingFile
A file that forwards all methods and properties to a delegate.
A link that forwards all methods and properties to a delegate.
ForwardingRandomAccessFile
A RandomAccessFile implementation that forwards all methods and properties to a delegate.

Extensions

AsyncExpand on Stream<T>
Alternatives to asyncExpand.
AsyncMap on Stream<T>
Alternatives to asyncMap.
CombineLatest on Stream<T>
Utilities to combine events from multiple streams through a callback or into a list.
Concatenate on Stream<T>
Utilities to append or prepend to a stream.
DdsExtension on VmService
FileSpanExtension on FileSpan
Extension methods on the FileSpan API.
LanguageVersionRelationalOperators on LanguageVersion
Relational operators for LanguageVersion that compare valid versions with LanguageVersion.compareTo.
Merge on Stream<T>
Utilities to interleave events from multiple streams.
RateLimit on Stream<T>
Utilities to rate limit events.
Scan on Stream<T>
A utility similar to fold which emits intermediate accumulations.
SourceSpanExtension on SourceSpan
Extension methods on the base SourceSpan API.
SourceSpanWithContextExtension on SourceSpanWithContext
Extension methods on the base SourceSpan API.
Switch on Stream<T>
A utility to take events from the most recent sub stream returned by a callback.
SwitchLatest on Stream<Stream<T>>
A utility to take events from the most recent sub stream.
TakeUntil on Stream<T>
A utility to end a stream based on an external trigger.
Tap on Stream<T>
A utility to chain extra behavior on a stream.
Where on Stream<T>
Utilities to filter events.
WhereNotNull on Stream<T?>

Constants

asciiGlyphs → const GlyphSet
A GlyphSet that always returns ASCII glyphs.
assertFailingTest → const Object
A marker annotation used to annotate test methods which are expected to fail when asserts are enabled.
defaultGetProjectRootsDepth → const int
The default value for the depth parameter in the DartToolingDaemon.getProjectRoots API.
emojis → const Map<String, String>
EXIT_CODE_BROKEN_PIPE → const int
EXIT_CODE_ERROR → const int
EXIT_CODE_OK → const int
failingTest → const Object
A marker annotation used to annotate test methods which are expected to fail.
kFileSystemServiceName → const String
Service name for the DTD-hosted file system service.
kUnifiedAnalyticsServiceName → const String
Service name for the DTD-hosted unified analytics service.
literalFalse → const Expression
Represents the literal value false.
literalNull → const Expression
Represents the literal value null.
literalTrue → const Expression
Represents the literal value true.
reflectiveTest → const Object
A marker annotation used to instruct dart2js to keep reflection information for the annotated classes.
skippedTest → const Object
A marker annotation used to annotate test methods that should be skipped.
soloTest → const Object
A marker annotation used to annotate "solo" groups and tests.
unicodeGlyphs → const GlyphSet
A GlyphSet that always returns Unicode glyphs.
version → const String

Properties

ascii bool
Whether the glyph getters return plain ASCII, as opposed to Unicode characters or sequences.
getter/setter pair
bottomLeftCorner String
The lower left-hand corner of a box.
no setter
bottomLeftCornerBold String
The bold lower left-hand corner of a box.
no setter
bottomLeftCornerDouble String
The double lower left-hand corner of a box.
no setter
bottomRightCorner String
The lower right-hand corner of a box.
no setter
bottomRightCornerBold String
The bold lower right-hand corner of a box.
no setter
bottomRightCornerDouble String
The double lower right-hand corner of a box.
no setter
bullet String
A bullet point.
no setter
clock Clock
The default implementation of clock for the current Zone.
no setter
cross String
An intersection of vertical and horizontal box lines.
no setter
crossBold String
An intersection of bold vertical and horizontal box lines.
no setter
crossDouble String
An intersection of double vertical and horizontal box lines.
no setter
defaultMagicNumbersMaxLength int
The maximum number of bytes needed, to match all default magic-numbers.
no setter
downArrow String
A downwards-pointing arrow.
no setter
downEnd String
The bottom half of a vertical box line.
no setter
downEndBold String
The bottom half of a bold vertical box line.
no setter
glyphs GlyphSet
Returns asciiGlyphs if ascii is true or unicodeGlyphs otherwise.
no setter
horizontalLine String
A horizontal line that can be used to draw a box.
no setter
horizontalLineBold String
A bold horizontal line that can be used to draw a box.
no setter
horizontalLineDouble String
A double horizontal line that can be used to draw a box.
no setter
horizontalLineDoubleDash String
A dashed horizontal line that can be used to draw a box.
no setter
horizontalLineDoubleDashBold String
A bold dashed horizontal line that can be used to draw a box.
no setter
horizontalLineQuadrupleDash String
A dashed horizontal line that can be used to draw a box.
no setter
horizontalLineQuadrupleDashBold String
A bold dashed horizontal line that can be used to draw a box.
no setter
horizontalLineTripleDash String
A dashed horizontal line that can be used to draw a box.
no setter
horizontalLineTripleDashBold String
A bold dashed horizontal line that can be used to draw a box.
no setter
jsonDocument StreamChannelTransformer<Object?, String>
A StreamChannelTransformer that transforms JSON documents—strings that contain individual objects encoded as JSON—into decoded Dart objects.
final
leftArrow String
A left-pointing arrow.
no setter
leftEnd String
The left half of a horizontal box line.
no setter
leftEndBold String
The left half of a bold horizontal box line.
no setter
longLeftArrow String
A two-character left-pointing arrow.
no setter
longRightArrow String
A two-character right-pointing arrow.
no setter
now DateTime
Returns the current time as reported by clock.
no setter
rightArrow String
A right-pointing arrow.
no setter
rightEnd String
The right half of a horizontal box line.
no setter
rightEndBold String
The right half of a bold horizontal box line.
no setter
sandbox String
The sandbox directory in which descriptors are created and validated by default.
no setter
sdkPath String
The path to the current Dart SDK.
no setter
teeDown String
A horizontal box line with a vertical line going down from the middle.
no setter
teeDownBold String
A bold horizontal box line with a vertical line going down from the middle.
no setter
teeDownDouble String
A double horizontal box line with a vertical line going down from the middle.
no setter
teeLeft String
A vertical box line with a horizontal line going left from the middle.
no setter
teeLeftBold String
A bold vertical box line with a horizontal line going left from the middle.
no setter
teeLeftDouble String
A double vertical box line with a horizontal line going left from the middle.
no setter
teeRight String
A vertical box line with a horizontal line going right from the middle.
no setter
teeRightBold String
A bold vertical box line with a horizontal line going right from the middle.
no setter
teeRightDouble String
A double vertical box line with a horizontal line going right from the middle.
no setter
teeUp String
A horizontal box line with a vertical line going up from the middle.
no setter
teeUpBold String
A bold horizontal box line with a vertical line going up from the middle.
no setter
teeUpDouble String
A double horizontal box line with a vertical line going up from the middle.
no setter
topLeftCorner String
The upper left-hand corner of a box.
no setter
topLeftCornerBold String
The bold upper left-hand corner of a box.
no setter
topLeftCornerDouble String
The double upper left-hand corner of a box.
no setter
topRightCorner String
The upper right-hand corner of a box.
no setter
topRightCornerBold String
The bold upper right-hand corner of a box.
no setter
topRightCornerDouble String
The double upper right-hand corner of a box.
no setter
upArrow String
An upwards-pointing arrow.
no setter
upEnd String
The top half of a vertical box line.
no setter
upEndBold String
The top half of a bold vertical box line.
no setter
verticalLine String
A vertical line that can be used to draw a box.
no setter
verticalLineBold String
A bold vertical line that can be used to draw a box.
no setter
verticalLineDouble String
A double vertical line that can be used to draw a box.
no setter
verticalLineDoubleDash String
A dashed vertical line that can be used to draw a box.
no setter
verticalLineDoubleDashBold String
A bold dashed vertical line that can be used to draw a box.
no setter
verticalLineQuadrupleDash String
A dashed vertical line that can be used to draw a box.
no setter
verticalLineQuadrupleDashBold String
A bold dashed vertical line that can be used to draw a box.
no setter
verticalLineTripleDash String
A dashed vertical line that can be used to draw a box.
no setter
verticalLineTripleDashBold String
A bold dashed vertical line that can be used to draw a box.
no setter
yamlWarningCallback YamlWarningCallback
A callback for emitting a warning.
getter/setter pair

Functions

applicationConfigHome(String productName) String
The user-specific application configuration folder for the current platform.
canonicalUriFor(AssetId id) String
Returns a canonical uri for id.
clientCredentialsGrant(Uri authorizationEndpoint, String? identifier, String? secret, {Iterable<String>? scopes, bool basicAuth = true, Client? httpClient, String? delimiter, Map<String, dynamic> getParameters(MediaType? contentType, String body)?}) Future<Client>
Obtains credentials using a client credentials grant.
collectPCOffsets(Iterable<String> lines, {bool lossy = false}) Iterable<PCOffset>
The PCOffsets for frames of the non-symbolic stack traces in lines.
crawlAsync<K extends Object, V>(Iterable<K> roots, FutureOr<V> readNode(K), FutureOr<Iterable<K>> edges(K, V)) Stream<V>
Finds and returns every node in a graph who's nodes and edges are asynchronously resolved.
declareConst(String variableName, {Reference? type}) Expression
Declare a const variable named variableName.
declareFinal(String variableName, {Reference? type, bool late = false}) Expression
Declare a final variable named variableName.
declareVar(String variableName, {Reference? type, bool late = false}) Expression
Declare a variable named variableName.
defineReflectiveSuite(void define(), {String name = ''}) → void
Run the define function parameter that calls defineReflectiveTests to add normal and "solo" tests, and also calls defineReflectiveSuite to create embedded suites. If the current suite is the top-level one, perform check for "solo" groups and tests, and run all or only "solo" items.
defineReflectiveTests(Type type) → void
Runs test methods existing in the given type.
dir(String name, [Iterable<Descriptor>? contents]) DirectoryDescriptor
Creates a new DirectoryDescriptor descriptor with name and contents.
dirPattern(Pattern name, [Iterable<Descriptor>? contents]) PatternDescriptor
A convenience method for creating a PatternDescriptor descriptor that constructs a DirectoryDescriptor descriptor.
equalsDart(String source, [DartEmitter? emitter]) → Matcher
Returns a matcher for Spec objects that emit code matching source.
extensionFromMime(String mimeType) String?
The default file extension for a given MIME type.
file(String name, [Object? contents]) FileDescriptor
Creates a new FileDescriptor with name and contents.
filePattern(Pattern name, [Object? contents]) PatternDescriptor
A convenience method for creating a PatternDescriptor descriptor that constructs a FileDescriptor descriptor.
findPackageConfig(Directory directory, {bool recurse = true, void onError(Object error)?, int minVersion = 1}) Future<PackageConfig?>
Finds a package configuration relative to directory.
findPackageConfigUri(Uri location, {bool recurse = true, int minVersion = 1, Future<Uint8List?> loader(Uri uri)?, void onError(Object error)?}) Future<PackageConfig?>
Finds a package configuration relative to location.
findUnusedPort() Future<int>
Returns a port that is probably, but not definitely, not in use.
getSdkPath() String
Returns the path to the current Dart SDK.
getStopwatch() Stopwatch
Returns a stopwatch that uses the current time as reported by clock.
glyphOrAscii(String glyph, String alternative) String
Returns glyph if Unicode glyph are allowed, and alternative if they aren't.
guessIndent(String code, int charOffset) String
Returns all whitespace characters at the start of charOffset's line.
invalidVariableName(String keyword, {bool strictMode = true}) bool
Returns true for invalid JS variable names, such as keywords. Also handles invalid variable names in strict mode, like "arguments".
lazyCode(Code generate()) Code
Returns a generic Code that is lazily generated when visited.
lazySpec(Spec generate()) Spec
Returns a generic Spec that is lazily generated when visited.
literal(Object? literal, {Expression onError(Object)?}) Expression
Converts a runtime Dart literal value into an Expression.
literalBool(bool value) Expression
Create a literal expression from a boolean value.
literalConstList(List<Object?> values, [Reference? type]) LiteralListExpression
Creates a literal const list expression from values.
literalConstMap(Map<Object?, Object?> values, [Reference? keyType, Reference? valueType]) → LiteralMapExpression
Create a literal const map expression from values.
literalConstRecord(List<Object?> positionalFieldValues, Map<String, Object?> namedFieldValues) → LiteralRecordExpression
Create a literal const record expression from positionalFieldValues and namedFieldValues.
literalConstSet(Set<Object?> values, [Reference? type]) → LiteralSetExpression
Creates a literal const set expression from values.
literalList(Iterable<Object?> values, [Reference? type]) LiteralListExpression
Creates a literal list expression from values.
literalMap(Map<Object?, Object?> values, [Reference? keyType, Reference? valueType]) → LiteralMapExpression
Create a literal map expression from values.
literalNullSafeSpread() Expression
Create a literal ...? operator for use when creating a Map literal.
literalNum(num value) Expression
Create a literal expression from a number value.
literalRecord(List<Object?> positionalFieldValues, Map<String, Object?> namedFieldValues) → LiteralRecordExpression
Create a literal record expression from positionalFieldValues and namedFieldValues.
literalSet(Iterable<Object?> values, [Reference? type]) → LiteralSetExpression
Creates a literal set expression from values.
literalSpread() Expression
Create a literal ... operator for use when creating a Map literal.
literalString(String value, {bool raw = false}) Expression
Create a literal expression from a string value.
loadPackageConfig(File file, {bool preferNewest = true, void onError(Object error)?}) Future<PackageConfig>
Reads a specific package configuration file.
loadPackageConfigUri(Uri file, {Future<Uint8List?> loader(Uri uri)?, bool preferNewest = true, void onError(Object error)?}) Future<PackageConfig>
Reads a specific package configuration URI.
loadYaml(String yaml, {Uri? sourceUrl, bool recover = false, ErrorListener? errorListener}) → dynamic
Loads a single document from a YAML string.
loadYamlDocument(String yaml, {Uri? sourceUrl, bool recover = false, ErrorListener? errorListener}) YamlDocument
Loads a single document from a YAML string as a YamlDocument.
loadYamlDocuments(String yaml, {Uri? sourceUrl}) List<YamlDocument>
Loads a stream of documents from a YAML string.
loadYamlNode(String yaml, {Uri? sourceUrl, bool recover = false, ErrorListener? errorListener}) YamlNode
Loads a single document from a YAML string as a YamlNode.
loadYamlStream(String yaml, {Uri? sourceUrl}) YamlList
Loads a stream of documents from a YAML string.
lookupMimeType(String path, {List<int>? headerBytes}) String?
Extract the extension from path and use that for MIME-type lookup, using the default extension map.
mapStackTrace(Mapping sourceMap, StackTrace stackTrace, {bool minified = false, Map<String, Uri>? packageMap, Uri? sdkRoot}) StackTrace
Convert stackTrace, a stack trace generated by dart2js-compiled JavaScript, to a native-looking stack trace using sourceMap.
markdownToHtml(String markdown, {Iterable<BlockSyntax> blockSyntaxes = const [], Iterable<InlineSyntax> inlineSyntaxes = const [], ExtensionSet? extensionSet, Resolver? linkResolver, Resolver? imageLinkResolver, bool inlineOnly = false, bool encodeHtml = true, bool enableTagfilter = false, bool withDefaultBlockSyntaxes = true, bool withDefaultInlineSyntaxes = true}) String
Converts the given string of Markdown to HTML.
nothing(String name) NothingDescriptor
Creates a new NothingDescriptor descriptor that asserts that no entry named name exists.
parse(String jsonMap, {Map<String, Map>? otherMaps, Object? mapUrl}) Mapping
Parses a source map directly from a json string.
parseExtended(String jsonMap, {Map<String, Map>? otherMaps, Object? mapUrl}) Mapping
Parses a source map or source map bundle directly from a json string.
parseJson(Map map, {Map<String, Map>? otherMaps, Object? mapUrl}) Mapping
Parses a source map.
parseJsonExtended(Object? json, {Map<String, Map>? otherMaps, Object? mapUrl}) Mapping
Parses a source map or source map bundle.
path(String path) String
Returns path within the sandbox directory.
pathToJSIdentifier(String path) String
Transforms a path to a valid JS identifier.
pattern(Pattern name, Descriptor child(String basename)) PatternDescriptor
Creates a new PatternDescriptor descriptor that asserts than an entry with a name matching pattern exists, and matches the Descriptor returned by child.
refer(String symbol, [String? url]) Reference
Short-hand for Reference(symbol, url).
registerCustomWatcher(String id, DirectoryWatcher? createDirectoryWatcher(String path, {Duration? pollingDelay})?, FileWatcher? createFileWatcher(String path, {Duration? pollingDelay})?) → void
Registers a custom watcher.
renderToHtml(List<Node> nodes, {bool enableTagfilter = false}) String
Renders nodes to HTML.
resourceOwnerPasswordGrant(Uri authorizationEndpoint, String username, String password, {String? identifier, String? secret, Iterable<String>? scopes, bool basicAuth = true, CredentialsRefreshedCallback? onCredentialsRefreshed, Client? httpClient, String? delimiter, Map<String, dynamic> getParameters(MediaType? contentType, String body)?}) Future<Client>
Obtains credentials using a resource owner password grant.
savePackageConfig(PackageConfig configuration, Directory directory) Future<void>
Writes a package configuration to the provided directory.
shortestPath<T extends Object>(T start, T target, Iterable<T> edges(T), {bool equals(T, T)?, int hashCode(T)?}) Iterable<T>?
Returns the shortest path from start to target given the directed edges of a graph provided by edges.
shortestPaths<T extends Object>(T start, Iterable<T> edges(T), {bool equals(T, T)?, int hashCode(T)?}) Map<T, Iterable<T>>
Returns a Map of the shortest paths from start to all of the nodes in the directed graph defined by edges.
stronglyConnectedComponents<T extends Object>(Iterable<T> nodes, Iterable<T> edges(T), {bool equals(T, T)?, int hashCode(T)?}) List<List<T>>
Finds the strongly connected components of a directed graph using Tarjan's algorithm.
systemTime() DateTime
Returns the current system time.
toJSIdentifier(String name) String
Escape name to make it into a valid identifier.
topologicalSort<T>(Iterable<T> nodes, Iterable<T> edges(T), {bool equals(T, T)?, int hashCode(T)?, Comparator<T>? secondarySort}) List<T>
Returns a topological sort of the nodes of the directed edges of a graph provided by nodes and edges.
transitiveClosure<T extends Object>(Iterable<T> nodes, Iterable<T> edges(T), {bool equals(T, T)?, int hashCode(T)?, bool acyclic = false}) Map<T, Set<T>>
Returns a transitive closure of a directed graph provided by nodes and edges.
tryParseSymbolOffset(String s, {bool forceHexadecimal = false, String? buildId, StackTraceHeader? header}) PCOffset?
Parses strings of the format <static symbol>+<integer offset>, where <static symbol> is one of the static symbols used for Dart instruction sections.
withClock<T>(Clock clock, T callback(), {bool isFinal = false}) → T
Runs callback with the given value for the top-level clock field.
wrapAsYamlNode(Object? value, {CollectionStyle collectionStyle = CollectionStyle.ANY, ScalarStyle scalarStyle = ScalarStyle.ANY}) YamlNode
Wraps value into a YamlNode.

Typedefs

ChainHandler = void Function(dynamic error, Chain chain)
A function that handles errors in the zone wrapped by Chain.capture.
ConnectionProvider = Future<ChromeConnection> Function()
CredentialsRefreshedCallback = void Function(Credentials)
Type of the callback when credentials are refreshed.
DevToolsLauncher = Future<DevTools> Function(String hostname)
DTDServiceCallback = Future<Map<String, Object?>> Function(Parameters params)
Resolver = Node? Function(String name, [String? title])
TimeFunction = DateTime Function()
Returns current time.
UriConverter = String? Function(String uri)
UrlEncoder = Future<String> Function(String url)
YamlWarningCallback = void Function(String message, [SourceSpan? span])
A callback for emitting a warning.

Exceptions / Errors

AbsoluteImportUriException
AliasException
Exception thrown when the path contains an alias along the way.
AppConnectionException
AuthorizationException
An exception raised when OAuth2 authorization fails.
ChromeDebugException
ChromeError
CycleException<T>
An exception indicating that a cycle was detected in a graph that was expected to be acyclic.
DartDevelopmentServiceException
Thrown by DDS during initialization failures, unexpected connection issues, and when attempting to spawn DDS when an existing DDS instance exists.
DartToolingDaemonConnectionException
EmptyOutputException
An indication that an output file which was expect to be non-empty had no content.
EnvironmentNotFoundException
Exception thrown if a required environment entry does not exist.
ExistingDartDevelopmentServiceException
Thrown when attempting to start a new DDS instance when one already exists.
ExpirationException
An exception raised when attempting to use expired OAuth2 credentials.
FileSystemException
Exception thrown when a file operation fails.
FormatterException
Thrown when one or more errors occurs while parsing the code to be formatted.
IOException
Base class for all IO related exceptions.
MimeMultipartException
MultiSourceSpanException
A SourceSpanException that also highlights some secondary spans to provide the user with extra context.
MultiSourceSpanFormatException
A MultiSourceSpanException that's also a FormatException.
OSError
An Exception holding information about an error from the operating system.
SourceSpanException
A class for exceptions that have source span information attached.
SourceSpanFormatException
A SourceSpanException that's also a FormatException.
StringScannerException
An exception thrown by a StringScanner that failed to parse a string.
UnexpectedOutputException
Exception thrown when the internal sanity check that only whitespace changes are made fails.
WebSocketChannelException
An exception thrown by a WebSocketChannel.
YamlException
An error thrown by the YAML processor.