toString method

@override String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Implementation

@override
String toString() {
  final buffer = StringBuffer(message);

  if (element case final element?) {
    try {
      final span = spanForElement(element);
      buffer
        ..writeln()
        ..writeln(span.start.toolString)
        ..write(span.highlight());
    } catch (_) {
      // Source for `element` wasn't found, it must be in a summary with no
      // associated source. We can still give the name.
      buffer
        ..writeln()
        ..writeln('Cause: $element');
    }
  }

  if (node case final node?) {
    try {
      final span = spanForNode(node);
      buffer
        ..writeln()
        ..writeln(span.start.toolString)
        ..write(span.highlight());
    } catch (_) {
      buffer
        ..writeln()
        ..writeln('Cause: $node');
    }
  }

  return buffer.toString();
}