Semantica.Lib.Checks 8.1.0

.NET 6.0

dotnet add package Semantica.Lib.Checks --version 8.1.0

NuGet\Install-Package Semantica.Lib.Checks -Version 8.1.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Semantica.Lib.Checks" Version="8.1.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Semantica.Lib.Checks" Version="8.1.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Semantica.Lib.Checks" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Semantica.Lib.Checks --version 8.1.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Semantica.Lib.Checks, 8.1.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Semantica.Lib.Checks@8.1.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Semantica.Lib.Checks&version=8.1.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Semantica.Lib.Checks&version=8.1.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Semantica.Lib.Checks

This package is part of the core packages of Semantica.Lib.

Summary

A library that provides types and statics to streamline guards and validations. The Chk and Chk<T> value types provide boolean-like behaviour but can be combined with a reason and/or a payload. Guard static methods throws exceptions when checks fail.

type Chk

Contains the Chk and Chk<T> types. These types can be thought of and manipulated as boolean types, but can also contain a (string) Reason, and in the case of the generic version, a Payload. Chk is used to streamline sequential checks by leveraging short-circuiting of boolean operators. This results in more elegant and consistently structured validation methods. The Reason can be used for either feedback or debugging purposes to make apparent why validation fails when there are multiple checks done. Payload can be used to return other types of additional information such as associated keys. There is also a non-determined outcome of Chk that is only a reason (Chk.Rsn) and/or a payload (Chk.Pld) associated with either a pass or a fail, that can be &&-ed or ||-ed onto a determined Pass/Fail. Through that mechanism reason and payload-creation can also be skipped using short-circuiting when not applicable.

Chk and Chk<T> can be implicitly cast to each other, although obviously payload will be lost when casting to the non-generic version. This can be done explicitly with the Simplify() method, or Simplify(out T) if you want to use the payload locally. There are operator overloads for and/or where the left operand is Chk and the right operand and result are Chk<T>, but short-circuiting is only possible in C# when both operands are of the same type, so can only be used as the bitwise, non short-circuit operators.

Using a non-determined (IsDetermined=false) instance with reason or payloads as the right hand side of and/or operators will result in an exception when the wrong operator is used for the wrong Pass-value. i.e. Fail reasons can only be or-ed, Pass reasons can only be and-ed.

As an optional safety feature, HasPassed() and HasFailed() can be used when evaluating the validation. The boolean value of an undetermined reason for pass will still be true (as will the Pass property), but HasPassed() will only return true when Pass and IsDetermined are true. HasFailed() will also return true when IsDetermined is false. This is for safety concerns, so a check will not pass when a non-determined instance is accidentally returned.

static Guard & Check

Provide more elegant method of implementing guards in your methods. The Guard static methods throws exceptions if a guard is not satisfied. By using the Check static methods that return Chk<CheckKind> values, a more comprehensive error message is generated than with the standard if/throw ArgumentException.

Examples

Chk

Most basic validation with short circuiting - condition 2 is only evaluated if condition 1 is true.

Chk validation = Chk.If(condition1) && Chk.If(condition2)
if (validation.HasPassed()) 
{
    //do work
}

Validation with basic reason.

Chk validation = Chk.If(condition1).Fails("condition 1 was not satisfied.")
if (validation.HasPassed()) 
{
    //do work
}
else return Conflict(validation.Reason);

Validation with reason short-cicuiting.

Chk validation = Chk.If(condition1) || Chk.Rsn.ForFail($"condition 1 on entity {(await GetEntity(key)).Name} was not satisfied.")
if (validation.HasPassed()) 
{
    //do work
}
else return Conflict(validation.Reason);

Name validation that returns the matching key.

public Chk<Key> ValidateName(string name) 
{
    var entity = await GetEntityByName(name);
    Chk validation = Chk.If(entity != null).Fails($"No entity with name '{name}' not found.")
        && Chk.If(entity.IsActive).Fails($"Entity with key {entity.Key} that matches name '{name}' is not active.");
    return Chk.WithPld(entity.Key);
}

Same name validation, but where the payload is only retrieved if previous validations passed.

public Chk<Key> ValidateName(string name) 
{
    var entity = await GetEntityByName(name);
    Chk<Key> validation = Chk.If(entity != null).Fails($"No entity with name '{name}' not found.");
    return validation && Chk.Pld.ForPass(await GetAssociatedEntityKey(entity));
}

Subsequent validation chaining with payload reuse

var validation = ValidateName(name).Simplify(out Key key) && ValidateSystemState(key);
if (validation.HasFailed()) 
    return Conflict(validation.Reason);
    
//do work

Documentation generated from the XMLDoc:

Lib.Checks

Check
CheckExtensions
Chk
Chk`1
ContractArgumentException
- #ctor()
- #ctor()
ContractArgumentNullException
- #ctor()
ContractArgumentOutOfRangeException
- #ctor()
ContractException
Guard
GuardArgumentException
- #ctor()
- #ctor()
GuardArgumentNullException
- #ctor()
GuardArgumentOutOfRangeException
- #ctor()
GuardException
IChk
- Failed
- Passed
- Reason
- HasFailed()
- HasPassed()
Pld
Rsn
Rsn
StateException
Throw

Check `type`

Namespace

Semantica.Checks

Summary

Provides a number of standard checks that can be used for guards. The CheckKind Payload indicates the type of check that has failed, so a proper exception(-message) can be constructed. The Reason will contain the expression passed on failure.

None `constants`

Summary

A passing Chk`1 of CheckKind.

AreEqual``1(left,right,leftExpression,rightExpression) `method`

Summary

Makes a check that passes if the left and the right are equal; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
left	``0	The `bool` result of a condition.
right	``0	The `bool` result of a condition.
leftExpression	System.String	The left expression to be added as reason on fail.
rightExpression	System.String	The right expression to be added as reason on fail.

Fails(description) `method`

Summary

Creates a failed check reason that can be ||'d onto an actual check in order to make the evaluation of the reason only evaluated if the check fails using short-circuit mechanisms.

Returns

A Chk`1 of CheckKind with the provided description.

Parameters

Name	Type	Description
description	System.String	Description of the failed check.

IsDefined(value,name) `method`

Summary

Makes a check of kind Defined that passes if value is a valid value for double; and fails if the value is double.NaN or double.Infinity.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Double	The value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

IsDefined(value,name) `method`

Summary

Makes a check of kind Defined that passes if value is a valid value for double; and fails if the value is double.NaN or double.Infinity.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Nullable{System.Double}	The value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

IsDefined``1(value,name) `method`

Summary

Makes a check of kind Defined that passes if value is a valid value for enum T; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	``0	The value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	Type of the enum value to check.

IsDefined``1(value,name) `method`

Summary

Makes a check of kind Defined that passes if value is a valid value for enum T; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Nullable{``0}	The value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	Type of the enum value to check.

IsDetermined``1(value,name) `method`

Summary

Makes a check of kind Defined that passes if value is determined; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	``0	The instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	The IDeterminable type of instance to check.

IsDetermined``1(value,name) `method`

Summary

Makes a check of kind Defined that passes if value is determined; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Nullable{``0}	The instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	The IDeterminable type of instance to check.

MaxLength(value,maxLength,name) `method`

Summary

Makes a check that passes if value is at most maxLength characters in length; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.String	The String instance to check.
maxLength	System.Int32	The maximal valid length for the input.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

MinLength(value,minLength,name) `method`

Summary

Makes a check that passes if value is not null and at least minLength characters in length; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.String	The String instance to check.
minLength	System.Int32	The minimal valid length for the input.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NonZero(value,name) `method`

Summary

Makes a check of kind NonZero that passes if value is not zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Int32	The `int` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NonZero(value,name) `method`

Summary

Makes a check of kind NonZero that passes if value is not zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Int16	The `short` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NonZero(value,name) `method`

Summary

Makes a check of kind NonZero that passes if value is not zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Int64	The `long` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NonZero(value,name) `method`

Summary

Makes a check of kind NonZero that passes if value is not zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Single	The `float` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NonZero(value,name) `method`

Summary

Makes a check of kind NonZero that passes if value is not zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Double	The `double` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NonZero(value,name) `method`

Summary

Makes a check of kind NonZero that passes if value is not zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Decimal	The `decimal` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Not(condition,expression) `method`

Summary

Makes a check that passes if condition is false; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
condition	System.Boolean	The `bool` result of a condition.
expression	System.String	The expression to be added as reason on fail.

NotDefault``1(value,name) `method`

Summary

Makes a check of kind NotNull that passes if value is not equal to default; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	``0	The instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	The IEquatable`1 type of instance to check.

NotEmpty(value,name) `method`

Summary

Makes a check of kind NotEmpty that passes if value is not Guid.Empty; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Guid	The Guid instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NotEmpty(value,name) `method`

Summary

Makes a check of kind NotEmpty that passes if value is not Guid.Empty; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Nullable{System.Guid}	The Guid instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NotEmpty(value,name) `method`

Summary

Makes a check of kind NotEmpty that passes if value is not null or an empty string; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.String	The String instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NotEmpty``1(collection,name) `method`

Summary

Makes a check of kind NotEmpty that passes if collection is not null and has at least one element; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
collection	System.Collections.Generic.IReadOnlyCollection{``0}	The collection instance to check.
name	System.String	Name/expression of the collection field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	The IReadOnlyCollection`1 type of instance to check.

NotEmpty``1(collection,name) `method`

Summary

Makes a check of kind NotEmpty that passes if collection is not null and has at least one element; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
collection	System.Collections.Generic.IReadOnlyList{``0}	The collection instance to check.
name	System.String	Name/expression of the collection field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	The IReadOnlyList`1 type of instance to check.

NotEmpty``1(value,name) `method`

Summary

Makes a check of kind NotEmpty that passes if value is not empty; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	``0	The instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	The ICanBeEmpty type of instance to check.

NotEmpty``1(value,name) `method`

Summary

Makes a check of kind NotEmpty that passes if value is not empty; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Nullable{``0}	The instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	The ICanBeEmpty type of instance to check.

NotNegative(value,name) `method`

Summary

Makes a check of kind NonNegative that passes if value is not negative; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Int32	The `int` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NotNegative(value,name) `method`

Summary

Makes a check of kind NonNegative that passes if value is not negative; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Int16	The `short` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NotNegative(value,name) `method`

Summary

Makes a check of kind NonNegative that passes if value is not negative; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Int64	The `long` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NotNegative(value,name) `method`

Summary

Makes a check of kind NonNegative that passes if value is not negative; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Single	The `float` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NotNegative(value,name) `method`

Summary

Makes a check of kind NonNegative that passes if value is not negative; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Double	The `double` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NotNegative(value,name) `method`

Summary

Makes a check of kind NonNegative that passes if value is not negative; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Decimal	The `decimal` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

NotNullOrDefault``1(value,name) `method`

Summary

Makes a check of kind NotNull that passes if value is not default, using de default EqualityComparer`1; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	``0	The instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	The reference type of instance to check.

NotNull``1(value,name) `method`

Summary

Makes a check of kind NotNull that passes if value is not null; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	``0	The instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	The reference type of instance to check.

NotNull``1(value,name) `method`

Summary

Makes a check of kind NotNull that passes if value is not null; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Nullable{``0}	The instance to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

Generic Types

Name	Description
T	The Nullable`1 value type of instance to check.

StrictPositive(value,name) `method`

Summary

Makes a check of kind StrictPositive that passes if value is greater than zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Int32	The `int` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

StrictPositive(value,name) `method`

Summary

Makes a check of kind StrictPositive that passes if value is greater than zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Int16	The `short` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

StrictPositive(value,name) `method`

Summary

Makes a check of kind StrictPositive that passes if value is greater than zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Int64	The `long` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

StrictPositive(value,name) `method`

Summary

Makes a check of kind StrictPositive that passes if value is greater than zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Single	The `float` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

StrictPositive(value,name) `method`

Summary

Makes a check of kind StrictPositive that passes if value is greater than zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Double	The `double` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

StrictPositive(value,name) `method`

Summary

Makes a check of kind StrictPositive that passes if value is greater than zero; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Decimal	The `decimal` value to check.
name	System.String	Name/expression of the value field, argument or property to check. Added as Reason on failure.

That(condition,expression) `method`

Summary

Makes a check that passes if condition is true; and fails otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
condition	System.Boolean	The `bool` result of a condition.
expression	System.String	The expression to be added as reason on fail.

WhenNotEmpty``1(value,check) `method`

Summary

Checks if value is not empty and only then returns check; returns a passed test otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	``0	The ICanBeEmpty instance to check.
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	The check to return if `value` is not empty.

Generic Types

Name	Description
T	The ICanBeEmpty type of instance to check.

WhenNotEmpty``1(value,check) `method`

Summary

Checks if value is not null or empty and only then returns check; returns a passed test otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Nullable{``0}	The nullable ICanBeEmpty instance to check.
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	The check to return if `value` is not empty.

Generic Types

Name	Description
T	The ICanBeEmpty type of instance to check.

WhenNotNull``1(value,check) `method`

Summary

Checks if value is not null and only then returns check; returns a passed test otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	System.Nullable{``0}	The Nullable`1 instance to check.
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	The check to return if `value` is not null.

Generic Types

Name	Description
T	The Nullable`1 type of instance to check.

WhenNotNull``1(value,check) `method`

Summary

Checks if value is not null and only then returns check; returns a passed test otherwise.

Returns

A new Chk`1 of CheckKind that is Passed when conditions are met.

Parameters

Name	Type	Description
value	``0	The instance to check.
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	The check to return if `value` is not null.

Generic Types

Name	Description
T	The reference type of instance to check.

CheckExtensions `type`

Namespace

Semantica.Checks

Summary

Provides extension methods on Chk of CheckKind that can be used for guarding of all three types ContractException, GuardException and StateException.

Contract(check) `method`

Summary

Throws if the check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the contract-subtypes when it's failed.

Contract(check,description) `method`

Summary

Throws if the check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check.
description	System.String	Description added to the thrown exception.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the contract-subtypes when it's failed.

Guard(check) `method`

Summary

Throws if the check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the guard-subtypes when it's failed.

Guard(check,description) `method`

Summary

Throws if the check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check.
description	System.String	Description added to the thrown exception.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the guard-subtypes when it's failed.

Out(check,chk) `method`

Summary

Assigns the input check to the out parameter chk, and also returns it.

Returns

The input.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Input Chk`1 of CheckKind.
chk	Semantica.Checks.Chk{Semantica.Checks.CheckKind}@	Out parameter that will contain a copy of `check`.

Remarks

This method can be used to assign the result of a check to a variable an in-line, making it more compact to use it in an if and it's then-statement.

State(check) `method`

Summary

Throws if the check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.

Exceptions

Name	Description
Semantica.Checks.Exceptions.StateException	Throws when `check` failed.

State(check,description) `method`

Summary

Throws if the check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check.
description	System.String	Description added to the thrown exception.

Exceptions

Name	Description
Semantica.Checks.Exceptions.StateException	Throws when `check` failed.

Chk `type`

Namespace

Semantica.Checks

Summary

Represents the result of a (bool) check, with an optional Reason.

Remarks

Instances of Chk can be used just as booleans. Short-circuiting is supported for operators && and ||. The Reason is always associated with a certain outcome (Passed or Failed). When two instances are combined with an operator, only the reasons that are associated with the outcome will be present in the result. Multiple applicable reasons are concatenated. Chk is IDeterminable. An undetermined instance has the meaning of only being a reason associated to a specific outcome, and it's value will never influence a binary operator's outcome.

Fail `property`

Summary

A Failed instance.

IsDetermined `property`

Summary

true for an actual check outcome. false if the instance is only a reason associated to a specific outcome. The value will never influence a binary operator's outcome.

Pass `property`

Summary

A Passed instance.

Fails(failReason) `method`

Summary

Makes an instance with a new value for Reason, but only if the check already Failed.

Returns

A new instance of Chk containing failReason if Failed, otherwise Reason is retained.

Parameters

Name	Type	Description
failReason	System.String	The new value of Reason if Failed

Fails``1(payload) `method`

Summary

Makes an instance with a new value for Payload, but only if the check already Failed.

Returns

A new instance of Chk`1 containing payload if Failed, otherwise the Payload is default.

Parameters

Name	Type	Description
payload	``0	The value of Payload if Failed.

Generic Types

Name	Description
TPayload	The type of the payload.

Fails``1(failReason,payload) `method`

Summary

Makes an instance with new values for Payload and Reason, but only if the check already Failed.

Returns

A new instance of Chk`1 containing failReason and payload if Failed, otherwise the Payload is default, and Reason is retained.

Parameters

Name	Type	Description
failReason	System.String	The new value of Reason if Failed.
payload	``0	The value of Payload if Failed.

Generic Types

Name	Description
TPayload	The type of the payload.

If(result) `method`

Summary

A new instance of Chk that Passed if result is true.

Returns

A new instance of Chk with no specified reason.

Parameters

Name	Type	Description
result	System.Boolean	`bool` result of some check.

If``1(result) `method`

Summary

A new instance of Chk`1 that Passed if result is true.

Returns

A new instance of Chk`1 with no specified reason or payload.

Parameters

Name	Type	Description
result	System.Boolean	`bool` result of some check.

Passes(passReason) `method`

Summary

Makes an instance with a new value for Reason, but only if the check already Passed.

Returns

A new instance of Chk`1 containing passReason if Passed, otherwise Reason is retained.

Parameters

Name	Type	Description
passReason	System.String	The new value of Reason if Passed.

Passes``1(payload) `method`

Summary

Makes an instance with a value for Payload, but only if the check already Passed.

Returns

A new instance of Chk`1 containing payload if Passed, otherwise the Payload is default.

Parameters

Name	Type	Description
payload	``0	The value of Payload if Passed.

Generic Types

Name	Description
TPayload	The type of the payload.

Passes``1(passReason,payload) `method`

Summary

Makes an instance with new values for Payload and Reason, but only if the check already Passed.

Returns

A new instance of Chk`1 containing passReason and payload if Passed, otherwise the Payload is default, and Reason is retained.

Parameters

Name	Type	Description
passReason	System.String	The new value of Reason if Passed.
payload	``0	The value of Payload if Passed.

Generic Types

Name	Description
TPayload	The type of the payload.

SplitReasons() `method`

Summary

If multiple reasons were previously combined, this method can split up these reasons.

Returns

A string[] containing all the reasons associated with the outcome.

Parameters

This method has no parameters.

ToString() `method`

Summary

Returns a descriptive version of the value of the instance.

Parameters

This method has no parameters.

WithPld``1(payload) `method`

Summary

Makes an instance with new values for Payload, regardless if the check Failed or Passed.

Returns

A new instance of Chk`1 containing payload.

Parameters

Name	Type	Description
payload	``0	The value of Payload.

Generic Types

Name	Description
TPayload	The type of the payload.

WithRsn(reason) `method`

Summary

Makes an instance with a new value for Reason, regardless if the check Failed or Passed.

Returns

A new instance of Chk containing reason.

Parameters

Name	Type	Description
reason	System.String	The new value of Reason.

op_BitwiseAnd(left,right) `method`

Summary

And-operator for two Chk instances.

Returns

Passed if left and right both Passed, otherwise Failed.

Parameters

Name	Type	Description
left	Semantica.Checks.Chk	The left operand.
right	Semantica.Checks.Chk	The right operand.

Exceptions

Name	Description
System.InvalidOperationException	When a fail reason Fail is used as right operand (IsDetermined is
`false`)

Remarks

If the outcome is Failed, only reasons of Failed inputs are retained in the output. If the outcome is Passed, only reasons of Passed inputs are retained in the output.

op_BitwiseOr(left,right) `method`

Summary

Or-operator for two Chk instances.

Returns

Passed if left or right have Passed, otherwise Failed.

Parameters

Name	Type	Description
left	Semantica.Checks.Chk	The left operand.
right	Semantica.Checks.Chk	The right operand.

Exceptions

Name	Description
System.InvalidOperationException	When a pass reason Pass is used as right operand (IsDetermined is
`false`).

Remarks

If the outcome is Failed, only reasons of Failed inputs are retained in the output. If the outcome is Passed, only reasons of Passed inputs are retained in the output.

op_False() `method`

Summary

Determines false-value of Chk instance.

Parameters

This method has no parameters.

Remarks

Required for short-circuiting.

op_LogicalNot() `method`

Summary

Not-operator.

Parameters

This method has no parameters.

Remarks

Required for short-circuiting.

op_True() `method`

Summary

Determines true-value of Chk instance.

Parameters

This method has no parameters.

Remarks

Required for short-circuiting.

Chk`1 `type`

Namespace

Semantica.Checks

Summary

Represents the result of a (bool) check, with an optional Reason and Payload of type T.

Remarks

Instances of Chk can be used just as booleans. Short-circuiting is supported for operators && and ||. The Reason and Payload are always associated with a certain outcome (Passed or Failed). When two instances are combined with an operator, only the reasons that are associated with the outcome will be present in the result. Multiple applicable reasons are concatenated. Chk`1 is IDeterminable. An undetermined instance has the meaning of only being a reason or payload associated to a specific outcome, and it's value will never influence a binary operator's outcome.

Fail `constants`

Summary

A Failed instance.

Pass `constants`

Summary

A Passed instance.

Payload `property`

Summary

A payload of type T associated with this check's Passed or Failed value.

Fails(failReason) `method`

Summary

Makes an instance with a new value for Reason, but only if the check already Failed.

Returns

A new instance of Chk`1 containing failReason if Failed, otherwise Reason is retained.

Parameters

Name	Type	Description
failReason	System.String	The new value of Reason if Failed.

Fails(payload) `method`

Summary

Makes an instance with a new value for Payload, but only if the check already Failed.

Returns

A new instance of Chk`1 containing payload if Failed, otherwise the Payload is default.

Parameters

Name	Type	Description
payload	`0	The value of Payload if Failed.

Fails(failReason,payload) `method`

Summary

Makes an instance with new values for Payload and Reason, but only if the check already Failed.

Returns

A new instance of Chk`1 containing failReason and payload if Failed, otherwise the Payload is default, and Reason is retained.

Parameters

Name	Type	Description
failReason	System.String	The new value of Reason if Failed.
payload	`0	The value of Payload if Failed.

Passes(passReason) `method`

Summary

Makes an instance with a new value for Reason, but only if the check already Passed.

Returns

A new instance of Chk`1 containing passReason if Passed, otherwise Reason is retained.

Parameters

Name	Type	Description
passReason	System.String	The new value of Reason if Passed.

Passes(payload) `method`

Summary

Makes an instance with a value for Payload, but only if the check already Passed.

Returns

A new instance of Chk`1 containing payload if Passed, otherwise the Payload is default.

Parameters

Name	Type	Description
payload	`0	The value of Payload if Passed.

Passes(passReason,payload) `method`

Summary

Makes an instance with new values for Payload and Reason, but only if the check already Passed.

Returns

A new instance of Chk`1 containing passReason and payload if Passed, otherwise the Payload is default, and Reason is retained.

Parameters

Name	Type	Description
passReason	System.String	The new value of Reason if Passed.
payload	`0	The value of Payload if Passed.

Simplify() `method`

Summary

Drops the payload and returns the non-generic Chk.

Returns

Chk with only value and reason retained.

Parameters

This method has no parameters.

Simplify(payload) `method`

Summary

Drops the payload and returns the non-generic Chk, and Payload as out-parameter.

Returns

Chk with only value and reason retained.

Parameters

Name	Type	Description
payload	`0@	Out-parameter contains the value of Payload.

SplitReasons() `method`

Summary

If multiple reasons were previously combined, this method can split up these reasons.

Returns

A string[] containing all the reasons associated with the outcome.

Parameters

This method has no parameters.

ToString() `method`

Summary

Inherit from parent.

Parameters

This method has no parameters.

op_BitwiseAnd(left,right) `method`

Summary

And-operator for two Chk`1 instances.

Returns

Passed if left and right both Passed, otherwise Failed.

Parameters

Name	Type	Description
left	Semantica.Checks.Chk{`0}	The left operand.
right	Semantica.Checks.Chk{`0}	The right operand.

Exceptions

Name	Description
System.InvalidOperationException	When a fail reason or payloads Fail is used as right operand (IsDetermined
is `false`).

Remarks

If the outcome is Failed, only reasons or payloads of Failed inputs are retained in the output. If the outcome is Passed, only reasons or payloads of Passed inputs are retained in the output.

op_BitwiseAnd(left,right) `method`

Summary

And-operator for two Chk`1 instances.

Returns

Passed if left and right both Passed, otherwise Failed.

Parameters

Name	Type	Description
left	Semantica.Checks.Chk{`0}	The left operand.
right	Semantica.Checks.Chk	The right operand.

Exceptions

Name	Description
System.InvalidOperationException	When a fail reason or payloads Fail is used as right operand (IsDetermined is
`false`).

Remarks

If the outcome is Failed, only reasons or payloads of Failed inputs are retained in the output. If the outcome is Passed, only reasons or payloads of Passed inputs are retained in the output. Cannot be used as short-circuiting operator (&&).

op_BitwiseOr(left,right) `method`

Summary

Or-operator for two Chk`1 instances.

Returns

Passed if left or right have Passed, otherwise Failed

Parameters

Name	Type	Description
left	Semantica.Checks.Chk{`0}	The left operand.
right	Semantica.Checks.Chk{`0}	The right operand.

Exceptions

Name	Description
System.InvalidOperationException	When a pass reason or payloads Pass is used as right operand (IsDetermined
is `false`)

Remarks

If the outcome is Failed, only reasons or payloads of Failed inputs are retained in the output. If the outcome is Passed, only reasons or payloads of Passed inputs are retained in the output.

op_BitwiseOr(left,right) `method`

Summary

Or-operator for two Chk`1 instances.

Returns

Passed if left or right have Passed, otherwise Failed

Parameters

Name	Type	Description
left	Semantica.Checks.Chk{`0}	The left operand.
right	Semantica.Checks.Chk	The right operand.

Exceptions

Name	Description
System.InvalidOperationException	When a pass reason or payloads Pass is used as right operand (IsDetermined
is `false`)

Remarks

op_False() `method`

Summary

Inherit from parent.

Parameters

This method has no parameters.

op_LogicalNot() `method`

Summary

Inherit from parent.

Parameters

This method has no parameters.

op_True() `method`

Summary

Inherit from parent.

Parameters

This method has no parameters.

ContractArgumentException `type`

Namespace

Semantica.Checks.Exceptions

Summary

A subtype of ArgumentException, meant to be thrown when a contract guard on the arguments of a method fails.

#ctor() `constructor`

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

#ctor() `constructor`

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

ContractArgumentNullException `type`

Namespace

Semantica.Checks.Exceptions

Summary

A subtype of ArgumentNullException, meant to be thrown when a contract guard on the arguments of a method fails.

#ctor() `constructor`

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

ContractArgumentOutOfRangeException `type`

Namespace

Semantica.Checks.Exceptions

Summary

A subtype of ArgumentOutOfRangeException, meant to be thrown when a contract guard on the arguments of a method fails.

#ctor() `constructor`

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

ContractException `type`

Namespace

Semantica.Checks.Exceptions

Summary

Provides a number of static methods that create exception instances to be thrown when contract guards fail.

Make() `method`

Summary

Makes a new ContractArgumentException.

Parameters

This method has no parameters.

Make() `method`

Summary

Makes a new ContractArgumentException.

Parameters

This method has no parameters.

MakeEmpty() `method`

Summary

Makes a new ContractArgumentNullException.

Parameters

This method has no parameters.

MakeEmpty() `method`

Summary

Makes a new ContractArgumentNullException.

Parameters

This method has no parameters.

MakeFor() `method`

Summary

Makes a new ContractArgumentException, ContractArgumentNullException or ContractArgumentOutOfRangeException, depending on the check's CheckKind.

Parameters

This method has no parameters.

MakeFor() `method`

Summary

Makes a new ContractArgumentException, ContractArgumentNullException or ContractArgumentOutOfRangeException, depending on the check's CheckKind.

Parameters

This method has no parameters.

MakeNonNegative() `method`

Summary

Makes a new ContractArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeNonNegative() `method`

Summary

Makes a new ContractArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeNonZero() `method`

Summary

Makes a new ContractArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeNonZero() `method`

Summary

Makes a new ContractArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeNull() `method`

Summary

Makes a new ContractArgumentNullException.

Parameters

This method has no parameters.

MakeNull() `method`

Summary

Makes a new ContractArgumentNullException.

Parameters

This method has no parameters.

MakeStrictPositive() `method`

Summary

Makes a new ContractArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeStrictPositive() `method`

Summary

Makes a new ContractArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeUndefined() `method`

Summary

Makes a new ContractArgumentException.

Parameters

This method has no parameters.

MakeUndefined() `method`

Summary

Makes a new ContractArgumentException.

Parameters

This method has no parameters.

Guard `type`

Namespace

Semantica.Checks

Summary

Provides static functions for guarding of all three types ContractException, GuardException and StateException.

Contract(check,expression) `method`

Summary

Throws if the argument check failed.

Parameters

Name	Type	Description
check	System.Boolean	`bool` result of a check.
expression	System.String	The expression to be added as description of failure.

Exceptions

Name	Description
Semantica.Checks.Exceptions.ContractArgumentException	Throws if `check` is `false`.

Contract(check,description,argumentName) `method`

Summary

Throws if the argument check failed.

Parameters

Name	Type	Description
check	System.Boolean	`bool` result of a check.
description	System.String	Description added to the thrown exception.
argumentName	System.String	Name of the argument that violates the code contract.

Exceptions

Name	Description
Semantica.Checks.Exceptions.ContractArgumentException	Throws if `check` is `false`.

Contract(check) `method`

Summary

Throws if the argument check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the contract-subtypes when it's failed.

Contract(check,description) `method`

Summary

Throws if the argument check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.
description	System.String	Description added to the thrown exception.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the contract-subtypes when it's failed.

For(check,expression) `method`

Summary

Throws if the argument check failed.

Parameters

Name	Type	Description
check	System.Boolean	`bool` result of a check.
expression	System.String	The expression to be added as description of failure.

Exceptions

Name	Description
Semantica.Checks.Exceptions.GuardArgumentException	Throws if `check` is `false`.

For(check,description,argumentName) `method`

Summary

Throws if the argument check failed.

Parameters

Name	Type	Description
check	System.Boolean	`bool` result of a check.
description	System.String	Description added to the thrown exception.
argumentName	System.String	Name of the argument that violates the code contract.

Exceptions

Name	Description
Semantica.Checks.Exceptions.GuardArgumentException	Throws if `check` is `false`.

For(check) `method`

Summary

Throws if the argument check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the guard-subtypes when it's failed.

For(check,description) `method`

Summary

Throws if the argument check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.
description	System.String	Description added to the thrown exception.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the guard-subtypes when it's failed.

For``1(check) `method`

Summary

Throws if the state check failed.

Parameters

Name	Type	Description
check	System.Boolean	`bool` result of a check.

Exceptions

Name	Description
System.Exception	Throws if `check` is `false`.

Index(index,end) `method`

Summary

Throws if the index is not in range.

Parameters

Name	Type	Description
index	System.Int32	Value of the index to check.
end	System.Int32	The exclusive end of the valid range.

Exceptions

Name	Description
System.IndexOutOfRangeException	Throws when index is less than `0`, or greater than or equal to `end`.

Index(index,start,end) `method`

Summary

Throws if the index is not in range.

Parameters

Name	Type	Description
index	System.Int32	Value of the index to check.
start	System.Int32	The inclusive start of the valid range.
end	System.Int32	The exclusive end of the valid range.

Exceptions

Name	Description
System.IndexOutOfRangeException	Throws when index is less than `start`, or greater than or equal to
`end`.

State(check,expression) `method`

Summary

Throws if the state check failed.

Parameters

Name	Type	Description
check	System.Boolean	`bool` result of a check.
expression	System.String	The expression to be added as description of failure.

Exceptions

Name	Description
Semantica.Checks.Exceptions.StateException	Throws if `check` is `false`.

State(check,description,fieldName) `method`

Summary

Throws if the state check failed.

Parameters

Name	Type	Description
check	System.Boolean	`bool` result of a check.
description	System.String	Description added to the thrown exception.
fieldName	System.String	Name of the field that indicates the unexpected state.

Exceptions

Name	Description
Semantica.Checks.Exceptions.StateException	Throws if `check` is `false`.

State(check) `method`

Summary

Throws if the state check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.

Exceptions

Name	Description
Semantica.Checks.Exceptions.StateException	Throws if `check` has failed.

State(check,description) `method`

Summary

Throws if the state check failed.

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.
description	System.String	Description added to the thrown exception.

Exceptions

Name	Description
Semantica.Checks.Exceptions.StateException	Throws if `check` has failed.

GuardArgumentException `type`

Namespace

Semantica.Checks.Exceptions

Summary

A subtype of ArgumentException, meant to be thrown when a guard on the arguments of a method fails.

#ctor() `constructor`

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

#ctor() `constructor`

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

GuardArgumentNullException `type`

Namespace

Semantica.Checks.Exceptions

Summary

A subtype of ArgumentNullException, meant to be thrown when a guard on the arguments of a method fails.

#ctor() `constructor`

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

GuardArgumentOutOfRangeException `type`

Namespace

Semantica.Checks.Exceptions

Summary

A subtype of ArgumentOutOfRangeException, meant to be thrown when a guard on the arguments of a method fails.

#ctor() `constructor`

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

GuardException `type`

Namespace

Semantica.Checks.Exceptions

Summary

Provides a number of static methods that create exception instances to be thrown when argument guards fail.

Make() `method`

Summary

Makes a new GuardArgumentException.

Parameters

This method has no parameters.

Make() `method`

Summary

Makes a new GuardArgumentException.

Parameters

This method has no parameters.

MakeEmpty() `method`

Summary

Makes a new GuardArgumentNullException.

Parameters

This method has no parameters.

MakeEmpty() `method`

Summary

Makes a new GuardArgumentNullException.

Parameters

This method has no parameters.

MakeFor() `method`

Summary

Makes a new GuardArgumentException, GuardArgumentNullException or GuardArgumentOutOfRangeException, depending on the check's CheckKind.

Parameters

This method has no parameters.

MakeFor() `method`

Summary

Makes a new GuardArgumentException, GuardArgumentNullException or GuardArgumentOutOfRangeException, depending on the check's CheckKind.

Parameters

This method has no parameters.

MakeIndex() `method`

Summary

Makes a new IndexOutOfRangeException

Parameters

This method has no parameters.

MakeMaxValue() `method`

Summary

Makes a new GuardArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeMaxValue() `method`

Summary

Makes a new GuardArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeNonNegative() `method`

Summary

Makes a new GuardArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeNonNegative() `method`

Summary

Makes a new GuardArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeNonZero() `method`

Summary

Makes a new GuardArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeNonZero() `method`

Summary

Makes a new GuardArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeNull() `method`

Summary

Makes a new GuardArgumentNullException.

Parameters

This method has no parameters.

MakeNull() `method`

Summary

Makes a new GuardArgumentNullException.

Parameters

This method has no parameters.

MakeStrictPositive() `method`

Summary

Makes a new GuardArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeStrictPositive() `method`

Summary

Makes a new GuardArgumentOutOfRangeException.

Parameters

This method has no parameters.

MakeUndefined() `method`

Summary

Makes a new GuardArgumentException.

Parameters

This method has no parameters.

MakeUndefined() `method`

Summary

Makes a new GuardArgumentException.

Parameters

This method has no parameters.

IChk `type`

Namespace

Semantica.Checks

Summary

Represents the result of a (bool) check, with an optional Reason.

Failed `property`

Summary

Not Passed. Always use HasFailed for control flow.

Passed `property`

Summary

Indicates if the Chk has passed or failed, or if the Reason is associated with passing or failing. Always use HasPassed for control flow.

Reason `property`

Summary

The string reason associated with this check's Passed or Failed value.

HasFailed() `method`

Summary

Has the check Failed or is it not IsDetermined. Use to check the outcome in control flow for safety.

Returns

true if either Passed or IsDetermined are false.

Parameters

This method has no parameters.

HasPassed() `method`

Summary

Has the check Passed and IsDetermined. Use to check the outcome in control flow for safety.

Returns

true only if Passed and IsDetermined are both true.

Parameters

This method has no parameters.

Pld `type`

Namespace

Semantica.Checks.Chk

Summary

Provides static functionality to create Chk instances with undetermined outcome. These instances are only a Payload and possibly a Reason associated with a specific eventual outcome.

ForFail``1(payload) `method`

Summary

An undetermined value with a fail reason that can be ||-attached to a determined check, so this expression will only be evaluated if needed.

Returns

Undetermined Failed Chk Payload.

Parameters

Name	Type	Description
payload	``0	The payload for failing.

ForFail``1(payload,reason) `method`

Summary

An undetermined value with a payload and a fail reason that can be ||-attached to a determined check, so this expression will only be evaluated if needed.

Returns

Undetermined Failed Chk Payload.

Parameters

Name	Type	Description
payload	``0	The payload for failing.
reason	System.String	The reason for failing.

ForPass``1(payload) `method`

Summary

An undetermined value with a pass reason that can be &&-attached to a determined check, so this expression will only be evaluated if needed.

Returns

Undetermined Passed Chk Payload.

Parameters

Name	Type	Description
payload	``0	The payload for passing.

ForPass``1(payload,reason) `method`

Summary

An undetermined value with a payload and a pass reason that can be &&-attached to a determined check, so this expression will only be evaluated if needed

Returns

Undetermined Passed Chk Payload.

Parameters

Name	Type	Description
payload	``0	The payload for passing.
reason	System.String	The reason for passing.

Rsn `type`

Namespace

Semantica.Checks.Chk

Summary

Provides static functionality to create Chk instances with undetermined outcome. These instances are only a Reason associated with a specific eventual outcome.

Rsn `type`

Namespace

Semantica.Checks.Chk`1

Summary

Inherit from parent.

Fail `property`

Summary

An undetermined Failed instance.

Pass `property`

Summary

An undetermined Passed instance.

Fail `property`

Summary

An undetermined Failed instance.

Pass `property`

Summary

An undetermined Passed instance.

ForFail(reason) `method`

Summary

An undetermined value with a failure reason that can be ||-attached to a determined check, so this expression will only be evaluated if needed, and short-circuited if not.

Returns

Undetermined Failed instance.

Parameters

Name	Type	Description
reason	System.String	The Reason for failure.

ForFail``1(reason) `method`

Summary

An undetermined value with a failure reason that can be ||-attached to a determined check, so this expression will only be evaluated if needed, and short-circuited if not.

Returns

Undetermined Failed instance.

Parameters

Name	Type	Description
reason	System.String	The Reason for failure

ForPass(reason) `method`

Summary

An undetermined value with a pass reason that can be &&-attached to a determined check, so this expression will only be evaluated if needed, and short-circuited if not.

Returns

Undetermined Passed instance.

Parameters

Name	Type	Description
reason	System.String	The Reason for passing.

ForPass``1(reason) `method`

Summary

An undetermined value with a pass reason that can be &&-attached to a determined check, so this expression will only be evaluated if needed, and short-circuited if not.

Returns

Undetermined Passed instance.

Parameters

Name	Type	Description
reason	System.String	The Reason for passing.

StateException `type`

Namespace

Semantica.Checks.Exceptions

Summary

A subtype of InvalidOperationException, meant to be thrown when a guard on the state when calling an instance method fails.

Also provides a number of static methods that create exception instances.

#ctor() `constructor`

Summary

Inherit from parent.

Parameters

This constructor has no parameters.

Make() `method`

Summary

Makes a new StateException.

Parameters

This method has no parameters.

Make() `method`

Summary

Makes a new StateException.

Parameters

This method has no parameters.

MakeEmpty() `method`

Summary

Makes a new StateException.

Parameters

This method has no parameters.

MakeFor() `method`

Summary

Makes a new StateException.

Parameters

This method has no parameters.

MakeFor() `method`

Summary

Makes a new StateException.

Parameters

This method has no parameters.

MakeNonNegative() `method`

Summary

Makes a new StateException.

Parameters

This method has no parameters.

MakeNonZero() `method`

Summary

Makes a new StateException.

Parameters

This method has no parameters.

MakeNull() `method`

Summary

Makes a new StateException.

Parameters

This method has no parameters.

MakeStrictPositive() `method`

Summary

Makes a new StateException.

Parameters

This method has no parameters.

MakeUndefined() `method`

Summary

Makes a new StateException.

Parameters

This method has no parameters.

Throw `type`

Namespace

Semantica.Checks

Summary

Static helper methods that always throw an exception

Contract(expression) `method`

Parameters

Name	Type	Description
expression	System.String	Expression that violated the code contract.

Exceptions

Name	Description
Semantica.Checks.Exceptions.ContractArgumentException	Throws always.

Contract(description,argumentName) `method`

Parameters

Name	Type	Description
description	System.String	Description added to the thrown exception.
argumentName	System.String	Name of the argument that violates the code contract.

Exceptions

Name	Description
Semantica.Checks.Exceptions.ContractArgumentException	Throws always.

ContractFor(check) `method`

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the contract-subtypes.

ContractFor(description,check) `method`

Parameters

Name	Type	Description
description	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Description added to the thrown exception.
check	System.String	Check result, optionally containing the kind of check.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the contract-subtypes.

Guard(expression) `method`

Parameters

Name	Type	Description
expression	System.String	Expression that violated the code contract.

Exceptions

Name	Description
Semantica.Checks.Exceptions.GuardArgumentException	Throws always.

Guard(description,argumentName) `method`

Parameters

Name	Type	Description
description	System.String	Description added to the thrown exception.
argumentName	System.String	Name of the argument that violates the code contract.

Exceptions

Name	Description
Semantica.Checks.Exceptions.GuardArgumentException	Throws always.

GuardFor(check) `method`

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the guard-subtypes.

GuardFor(description,check) `method`

Parameters

Name	Type	Description
description	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Description added to the thrown exception.
check	System.String	Check result, optionally containing the kind of check.

Exceptions

Name	Description
System.ArgumentException	Depending on the kind of check, throws one of the guard-subtypes.

State(expression) `method`

Parameters

Name	Type	Description
expression	System.String	Expression that failed the state guard.

Exceptions

Name	Description
Semantica.Checks.Exceptions.StateException	Throws always.

State(description,fieldName) `method`

Parameters

Name	Type	Description
description	System.String	Description added to the thrown exception.
fieldName	System.String	Name of the field that indicates the unexpected state.

Exceptions

Name	Description
Semantica.Checks.Exceptions.StateException	Throws always.

StateFor(check,fieldName) `method`

Parameters

Name	Type	Description
check	Semantica.Checks.Chk{Semantica.Checks.CheckKind}	Check result, optionally containing the kind of check and/or description.
fieldName	System.String	Name of the field that indicates the unexpected state.

Exceptions

Name	Description
Semantica.Checks.Exceptions.StateException	Throws always.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Semantica.Lib.Patterns (>= 8.1.0)
net7.0
- Semantica.Lib.Patterns (>= 8.1.0)
net8.0
- Semantica.Lib.Patterns (>= 8.1.0)

NuGet packages (14)

Showing the top 5 NuGet packages that depend on Semantica.Lib.Checks:

Package	Downloads
Semantica.Lib.Linq A library that provides extensions that expand on the standard System.Linq functionality on IEnumerable<T> and IQueryable<T>, as well as provide optimized extensions/overloads for the IReadOnlyList<T>, IReadOnlyCollection<T> and IReadOnlyDictionary<TKey,T> interfaces.	8.0K
Semantica.Lib.Order A library that provides types and extensions that represent and help with ordering of collections.	6.5K
Semantica.Lib.Collections A library that provides a number of collection types that can help with either more readable/elegant syntax, or improved performance compared to native collection types.	6.1K
Semantica.Lib.Patterns.CanSerialize Provides typeconverters and (System.Text.Json) jsonconverters for types that implement ICanSerialize (one-way) or ICanSerialize<T> (two-way).	5.9K
Semantica.Lib.Package.Core Combines all primary Semantica.Lib.Core packages in a single package. Check the ReadMe of each package for further elaboration on package contents.	5.8K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
8.1.0	177	5/30/2025
8.0.7	280	9/6/2024
8.0.6-beta	850	7/10/2024
8.0.5-beta	906	7/4/2024
8.0.4-beta	235	7/2/2024
8.0.3-beta	231	6/14/2024
8.0.2-beta	308	6/4/2024
8.0.1-beta	236	6/4/2024
8.0.0-beta	246	6/4/2024
6.6.1-beta	349	4/5/2024
6.6.0-beta	387	3/5/2024
6.5.5-alpha2	135	3/4/2024
6.5.5-alpha	133	3/4/2024
6.5.4-beta	161	2/29/2024
6.5.3-beta	895	10/5/2023
6.5.2-beta	172	10/5/2023
6.5.1-beta	227	9/29/2023
6.5.0-beta	183	9/22/2023
6.4.0-beta	487	7/11/2023
6.3.0-beta	193	6/15/2023
6.2.5-beta	277	3/14/2023
6.2.4-beta	637	10/12/2022
6.2.3-beta	332	9/1/2022
6.2.1-beta	237	8/25/2022

Semantica.Lib.Checks 8.1.0

Semantica.Lib.Checks

Summary

Contents

type Chk

static Guard & Check

Examples

Chk

Lib.Checks

Contents

Check type

Namespace

Summary

None constants

Summary

AreEqual``1(left,right,leftExpression,rightExpression) method

Summary

Returns

Parameters

Fails(description) method

Summary

Returns

Parameters

IsDefined(value,name) method

Summary

Returns

Parameters

IsDefined(value,name) method

Summary

Returns

Parameters

IsDefined``1(value,name) method

Summary

Returns

Parameters

Generic Types

IsDefined``1(value,name) method

Summary

Returns

Parameters

Generic Types

IsDetermined``1(value,name) method

Summary

Returns

Parameters

Generic Types

IsDetermined``1(value,name) method

Summary

Returns

Parameters

Generic Types

MaxLength(value,maxLength,name) method

Summary

Returns

Parameters

MinLength(value,minLength,name) method

Summary

Returns

Parameters

NonZero(value,name) method

Summary

Returns

Parameters

NonZero(value,name) method

Summary

Returns

Parameters

NonZero(value,name) method

Summary

Returns

Parameters

NonZero(value,name) method

Summary

Returns

Parameters

NonZero(value,name) method

Summary

Returns

Parameters

NonZero(value,name) method

Check `type`

None `constants`

AreEqual``1(left,right,leftExpression,rightExpression) `method`

Fails(description) `method`

IsDefined(value,name) `method`

IsDefined(value,name) `method`

IsDefined``1(value,name) `method`

IsDefined``1(value,name) `method`

IsDetermined``1(value,name) `method`

IsDetermined``1(value,name) `method`

MaxLength(value,maxLength,name) `method`

MinLength(value,minLength,name) `method`

NonZero(value,name) `method`

NonZero(value,name) `method`

NonZero(value,name) `method`

NonZero(value,name) `method`

NonZero(value,name) `method`

NonZero(value,name) `method`

Not(condition,expression) `method`

NotDefault``1(value,name) `method`

NotEmpty(value,name) `method`

NotEmpty(value,name) `method`

NotEmpty(value,name) `method`

NotEmpty``1(collection,name) `method`

NotEmpty``1(collection,name) `method`

NotEmpty``1(value,name) `method`

NotEmpty``1(value,name) `method`

NotNegative(value,name) `method`

NotNegative(value,name) `method`

NotNegative(value,name) `method`

NotNegative(value,name) `method`

NotNegative(value,name) `method`

NotNegative(value,name) `method`

NotNullOrDefault``1(value,name) `method`