toString method

@override String toString([ PackageDetail? detail ])

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([PackageDetail? detail]) {
  detail ??= PackageDetail.defaults;
  if (isRoot) return name;

  final buffer = StringBuffer(name);
  if (detail.showSource ?? description is! HostedDescription) {
    buffer.write(' from ${description.source}');
    if (detail.showDescription) {
      buffer.write(' ${description.format()}');
    }
  }

  return buffer.toString();
}