Class Contract

Namespace

MarymoorStudios.Core

Assembly

MarymoorStudios.Core.dll

Used to check contract invariants in either Debug-only (Assert) or Debug and Release (Requires, Invariant, etc.). Contract failures will attempt to break into the debugger, will trace the error, and will throw a ContractViolationException.

public static class Contract

Inheritance

object

Contract

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Assert(bool)

[Conditional("DEBUG")]
public static void Assert(bool condition)

Parameters

condition bool

Assert(bool, string)

[Conditional("DEBUG")]
public static void Assert(bool condition, string message)

Parameters

condition bool

message string

Assert<T>(T, bool)

public static T Assert<T>(T retval, bool condition)

Parameters

retval T

condition bool

Returns

T

Type Parameters

T

Assert<T>(T, bool, string)

public static T Assert<T>(T retval, bool condition, string message)

Parameters

retval T

condition bool

message string

Returns

T

Type Parameters

T

Fail()

public static void Fail()

Fail(string)

public static void Fail(string message)

Parameters

message string

FailThrow(string)

public static Exception FailThrow(string message)

Parameters

message string

Returns

Exception

Invariant(bool)

public static void Invariant(bool condition)

Parameters

condition bool

Invariant(bool, string)

public static void Invariant(bool condition, string message)

Parameters

condition bool

message string

Requires(bool)

public static void Requires(bool condition)

Parameters

condition bool

Requires(bool, string)

public static void Requires(bool condition, string message)

Parameters

condition bool

message string

Unused<T>(T)

Used to annotate unused parameters to indicate that they are required for method signature contractual reasons even if they are unused in the current implementation.

[Conditional("DEBUG")]
public static void Unused<T>(T unused)

Parameters

unused T

The unused parameter.

Type Parameters

T

Any type.