Class IntegrityReportText

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

Renders an IntegrityReport as human-readable text.

public static class IntegrityReportText

Inheritance

object

IntegrityReportText

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Findings are ranked by severity and the loss summary comes last, so it is the parting message rather than something scrolled past. The limits block prints on a green report too — that is the whole point of it.

Methods

Render(IntegrityReport, bool)

Renders the full report.

public static string Render(IntegrityReport report, bool colour = false)

Parameters

report IntegrityReport

The report to render.

colour bool

Whether to emit ANSI colour escapes.

Returns

string

Exceptions

ArgumentNullException

report is null.