toString method

  1. @override
String toString()
override

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()..write('Engine error: $message');

  // Add sequence bytes as hex dump if available
  if (rawBytes.isNotEmpty) {
    buffer
      ..write('\n  Sequence: ')
      ..write(rawBytes.toHexString())
      ..write(' (');
    for (final b in rawBytes) {
      if (b.isPrintable) {
        buffer.write(String.fromCharCode(b));
      } else if (b == 0x1B) {
        buffer.write('ESC');
      } else {
        buffer.write('.');
      }
      buffer.write(' ');
    }
    buffer.write(')');
  }

  if (partialParameters.isNotEmpty) {
    buffer.write('\n  Partial params: [${partialParameters.map((p) => '"$p"').join(', ')}]');
  }

  return buffer.toString();
}