Class RedactedText

Namespace

MailFathom.Application.SensitiveContent.Redaction

Assembly

MailFathom.Application.dll

Text a consumer may hand on, and what had to be removed from it first.

public sealed record RedactedText : IEquatable<RedactedText>

Inheritance

object

RedactedText

Implements

IEquatable<RedactedText>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Text is the only part that leaves the process. The findings beside it describe what was removed — their categories, their positions in the text that was analyzed, and what detected them — and never what was removed, so a consumer can count, attribute, and audit a redaction without recreating the leak it prevented.

Findings are reported as the scanners produced them, which is before overlapping regions were merged. One placeholder therefore need not correspond to exactly one finding: two detectors recognizing the same credential produce two findings and one placeholder, which is the honest reading of both numbers.

Properties

Findings

Gets every finding the scanners reported, ordered by position and, at one position, widest first.

IsRedacted

Gets whether anything was redacted at all.

OmittedCharacterCount

Gets how many characters were dropped because they lay beyond what one scan analyzes.

Text

Gets the text with every detected region replaced by its placeholder.

Methods

Create(string, IReadOnlyList<SensitiveContentFinding>, int)

Records a redaction.