TextFilterStatistics Class

Definition

Namespace

Bodu.Text.Filtering

Assembly

Bodu.Text.Filtering.dll

Package

Bodu.Text.Filtering 1.0.0

Source

TextFilterStatistics.cs

Represents an immutable snapshot of a TextFilter's accumulated evaluation statistics, obtained via GetStatistics().

public sealed class TextFilterStatistics

Inheritance

object

TextFilterStatistics

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Remarks

Counter totals reconcile: ItemsEvaluated equals ItemsAccepted + ItemsExcluded + ItemsNotIncluded. Under concurrent evaluation the counters may undercount (they are deliberately not interlocked to keep the evaluation path cheap); matching results themselves are always exact.

Properties

EvaluationTime

Gets the accumulated time spent evaluating values.

public TimeSpan EvaluationTime { get; }

Property Value

TimeSpan

The accumulated evaluation time, or Zero when CaptureEvaluationTime is disabled.

ItemsAccepted

Gets the number of evaluated values that were accepted - the sum of the IncludedByDefault and Included outcomes.

public long ItemsAccepted { get; }

Property Value

long

ItemsEvaluated

Gets the total number of values evaluated since the filter was built or its statistics were last reset.

public long ItemsEvaluated { get; }

Property Value

long

ItemsExcluded

Gets the number of evaluated values rejected by an exclude pattern (the Excluded outcome).

public long ItemsExcluded { get; }

Property Value

long

ItemsNotIncluded

Gets the number of evaluated values rejected because include patterns exist and none matched (the NotIncluded outcome).

public long ItemsNotIncluded { get; }

Property Value

long

Patterns

Gets the per-pattern statistics, ordered as the patterns were declared.

public IReadOnlyList<TextFilterPatternStatistics> Patterns { get; }

Property Value

IReadOnlyList<TextFilterPatternStatistics>

RegexTimeouts

Gets the number of pattern evaluations that timed out in the regular-expression engine and were decided fail-safe (a timed-out include treated as not matching; a timed-out exclude treated as matching).

public long RegexTimeouts { get; }

Property Value

long

Applies to

Product	Versions
.NET	8, 10