Class Guard

Namespace

Support

Assembly

Support.dll

A class that can be used to count things (typically executions) and throw an exception if the count exceeds a limit.

public class Guard

Inheritance

object

Guard

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Applications.ApplyInterpolationRule<T, TBuffer>(TBuffer, Func<T, T, T>)

Applications.ApplyInterpolationRule<T, TBuffer>(TBuffer, Func<T, T, T>, int)

Applications.Interpolate<T, TBuffer>(TBuffer, Func<T, T, T>, int)

Applications.Substitute<T, TBuffer>(TBuffer, (T input, T[] output)[])

Comparable.ToComparable<T>(T, IComparer<T>)

Formatter.AsText<T>(T?)

Formatter.Describe<TLabel, TDescription>(TLabel, TDescription, string)

Formatter.Log<T>(T)

Formatter.Pretty<T>(T, params int[])

Remarks

This class is used to implement RecursionDepthGuard and IterationGuard.

This class can be used as a straight forward counter (for example, to count the number of iterations in a loop), or as a counter that can be incremented and decremented (for example, to count the recursion depth).

Constructors

Guard(int, string, string)

A class that can be used to count things (typically executions) and throw an exception if the count exceeds a limit.

public Guard(int defaultLimit, string limitExceededMessage, string incDecMismatchMessage)

Parameters

defaultLimit int

The default limit that is used if no limit is in Reset().

limitExceededMessage string

The error message to display when the limit is exceeded.

incDecMismatchMessage string

The error message to display when Dec() has been called more than Inc().

Remarks

This class is used to implement RecursionDepthGuard and IterationGuard.

This class can be used as a straight forward counter (for example, to count the number of iterations in a loop), or as a counter that can be incremented and decremented (for example, to count the recursion depth).

Methods

Dec()

Decrements the counter.

public void Dec()

Remarks

Dec should never be called more times than Inc(); the idea is that this keeps track of scope exists (while Inc keeps track of scope enters).

Exceptions

InvalidOperationException

Dec()has been called more than Inc().

See Also

RecursionDepthGuard

Inc()

Increments the counter.

public void Inc()

Exceptions

InvalidOperationException

The limit is exceeded.

Reset()

Resets the counter to zero and sets the limit to the default value.

public void Reset()

Reset(int)

Resets the counter to zero and sets the limit to the specified value.

public void Reset(int limit)

Parameters

limit int

The limit.