DiagnosticsBlock class

DiagnosticsNode that exists mainly to provide a container for other diagnostics that typically lacks a meaningful value of its own.

This class is typically used for displaying complex nested error messages.

Inheritance
Implementers

Constructors

DiagnosticsBlock({String? name, DiagnosticsTreeStyle style = DiagnosticsTreeStyle.whitespace, bool showName = true, bool showSeparator = true, String? linePrefix, Object? value, String? description, DiagnosticLevel level = DiagnosticLevel.info, bool allowTruncate = false, List<DiagnosticsNode> children = const <DiagnosticsNode>[], List<DiagnosticsNode> properties = const <DiagnosticsNode>[]})
Creates a diagnostic with properties specified by properties and children specified by children.

Properties

allowNameWrap bool
Whether to wrap the name onto multiple lines or not.
no setterinherited
allowTruncate bool
Whether to allow truncation when displaying the node and its children.
final
allowWrap bool
Whether to wrap text on onto multiple lines or not.
no setterinherited
emptyBodyDescription String?
Description to show if the node has no displayed properties or children.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
level DiagnosticLevel
Priority level of the diagnostic used to control which diagnostics should be shown and filtered.
final
linePrefix String?
Prefix to include at the start of each line.
finalinherited
name String?
Label describing the DiagnosticsNode, typically shown before a separator (see showSeparator).
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showName bool
Whether the name of the property should be shown when showing the default view of the tree.
finalinherited
showSeparator bool
Whether to show a separator between name and description.
finalinherited
style DiagnosticsTreeStyle?
Hint for how the node should be displayed.
finalinherited
textTreeConfiguration TextTreeConfiguration?
Returns a configuration specifying how this object should be rendered as text art.
no setterinherited
value Object?
The actual object this is diagnostics data for.
final

Methods

getChildren() List<DiagnosticsNode>
Children of this DiagnosticsNode.
override
getProperties() List<DiagnosticsNode>
Properties of this DiagnosticsNode.
override
isFiltered(DiagnosticLevel minLevel) bool
Whether the diagnostic should be filtered due to its level being lower than minLevel.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDescription({TextTreeConfiguration? parentConfiguration}) String
Returns a description with a short summary of the node itself not including children or properties.
override
toJsonMap(DiagnosticsSerializationDelegate delegate) Map<String, Object?>
Serialize the node to a JSON map according to the configuration provided in the DiagnosticsSerializationDelegate.
inherited
toString({TextTreeConfiguration? parentConfiguration, DiagnosticLevel minLevel = DiagnosticLevel.info}) String
Returns a string representation of this diagnostic that is compatible with the style of the parent if the node is not the root.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, TextTreeConfiguration? parentConfiguration, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
inherited
toTimelineArguments() Map<String, String>?
Converts the properties (getProperties) of this node to a form useful for Timeline event arguments (as in Timeline.startSync).
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited