Class Is

Helper class with properties and methods that supply a number of constraints used in Asserts.

Inheritance

object

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: NUnit.Framework

Assembly: nunit.framework.dll

Syntax

public abstract class Is

Constructors

View Source

Is()

Declaration

protected Is()

Properties

View Source

All

Returns a ConstraintExpression, which will apply the following constraint to all members of a collection, succeeding if all of them succeed.

Declaration

public static ConstraintExpression All { get; }

Property Value

Type	Description
ConstraintExpression

View Source

Default

Returns a constraint that tests for default value

Declaration

public static DefaultConstraint Default { get; }

Property Value

Type	Description
DefaultConstraint

View Source

Empty

Returns a constraint that tests for empty

Declaration

public static EmptyConstraint Empty { get; }

Property Value

Type	Description
EmptyConstraint

View Source

False

Returns a constraint that tests for False

Declaration

public static FalseConstraint False { get; }

Property Value

Type	Description
FalseConstraint

View Source

NaN

Returns a constraint that tests for NaN

Declaration

public static NaNConstraint NaN { get; }

Property Value

Type	Description
NaNConstraint

View Source

Negative

Returns a constraint that tests for a negative value

Declaration

public static LessThanConstraint Negative { get; }

Property Value

Type	Description
LessThanConstraint

View Source

Not

Returns a ConstraintExpression that negates any following constraint.

Declaration

public static ConstraintExpression Not { get; }

Property Value

Type	Description
ConstraintExpression

View Source

Null

Returns a constraint that tests for null

Declaration

public static NullConstraint Null { get; }

Property Value

Type	Description
NullConstraint

View Source

Ordered

Returns a constraint that tests whether a collection is ordered

Declaration

public static CollectionOrderedConstraint Ordered { get; }

Property Value

Type	Description
CollectionOrderedConstraint

View Source

Positive

Returns a constraint that tests for a positive value

Declaration

public static GreaterThanConstraint Positive { get; }

Property Value

Type	Description
GreaterThanConstraint

View Source

True

Returns a constraint that tests for True

Declaration

public static TrueConstraint True { get; }

Property Value

Type	Description
TrueConstraint

View Source

Unique

Returns a constraint that tests whether a collection contains all unique items.

Declaration

public static UniqueItemsConstraint Unique { get; }

Property Value

Type	Description
UniqueItemsConstraint

View Source

WhiteSpace

Returns a constraint that tests for white-space

Declaration

public static WhiteSpaceConstraint WhiteSpace { get; }

Property Value

Type	Description
WhiteSpaceConstraint

View Source

XmlSerializable

Returns a constraint that tests whether an object graph is serializable in XML format.

Declaration

public static XmlSerializableConstraint XmlSerializable { get; }

Property Value

Type	Description
XmlSerializableConstraint

View Source

Zero

Returns a constraint that tests for equality with zero

Declaration

public static EqualConstraint Zero { get; }

Property Value

Type	Description
EqualConstraint

Methods

View Source

AnyOf(ICollection)

Returns a constraint that tests if an item is equal to any of parameters

Declaration

public static AnyOfConstraint AnyOf(ICollection expected)

Parameters

Type	Name	Description
ICollection	expected	Expected values

Returns

Type	Description
AnyOfConstraint

View Source

AnyOf(params object?[]?)

Returns a constraint that tests if an item is equal to any of parameters

Declaration

public static AnyOfConstraint AnyOf(params object?[]? expected)

Parameters

Type	Name	Description
object[]	expected	Expected values

Returns

Type	Description
AnyOfConstraint

View Source

AssignableFrom(Type)

Returns a constraint that tests whether the actual value is assignable from the type supplied as an argument.

Declaration

public static AssignableFromConstraint AssignableFrom(Type expectedType)

Parameters

Type	Name	Description
Type	expectedType

Returns

Type	Description
AssignableFromConstraint

View Source

AssignableFrom<TExpected>()

Returns a constraint that tests whether the actual value is assignable from the type supplied as an argument.

Declaration

public static AssignableFromConstraint AssignableFrom<TExpected>()

Returns

Type	Description
AssignableFromConstraint

Type Parameters

Name	Description
TExpected

View Source

AssignableTo(Type)

Returns a constraint that tests whether the actual value is assignable to the type supplied as an argument.

Declaration

public static AssignableToConstraint AssignableTo(Type expectedType)

Parameters

Type	Name	Description
Type	expectedType

Returns

Type	Description
AssignableToConstraint

View Source

AssignableTo<TExpected>()

Returns a constraint that tests whether the actual value is assignable to the type supplied as an argument.

Declaration

public static AssignableToConstraint AssignableTo<TExpected>()

Returns

Type	Description
AssignableToConstraint

Type Parameters

Name	Description
TExpected

View Source

AtLeast(object)

Returns a constraint that tests whether the actual value is greater than or equal to the supplied argument

Declaration

public static GreaterThanOrEqualConstraint AtLeast(object expected)

Parameters

Type	Name	Description
object	expected

Returns

Type	Description
GreaterThanOrEqualConstraint

View Source

AtMost(object)

Returns a constraint that tests whether the actual value is less than or equal to the supplied argument

Declaration

public static LessThanOrEqualConstraint AtMost(object expected)

Parameters

Type	Name	Description
object	expected

Returns

Type	Description
LessThanOrEqualConstraint

View Source

EqualTo(byte)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<byte> EqualTo(byte expected)

Parameters

Type	Name	Description
byte	expected

Returns

Type	Description
EqualNumericConstraint<byte>

View Source

EqualTo(DateTime)

Returns a constraint that tests two date time instances for equality.

Declaration

public static EqualTimeBaseConstraint<DateTime> EqualTo(DateTime expected)

Parameters

Type	Name	Description
DateTime	expected

Returns

Type	Description
EqualTimeBaseConstraint<DateTime>

View Source

EqualTo(DateTimeOffset)

Returns a constraint that tests two date time offset instances for equality.

Declaration

public static EqualDateTimeOffsetConstraint EqualTo(DateTimeOffset expected)

Parameters

Type	Name	Description
DateTimeOffset	expected

Returns

Type	Description
EqualDateTimeOffsetConstraint

View Source

EqualTo(decimal)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<decimal> EqualTo(decimal expected)

Parameters

Type	Name	Description
decimal	expected

Returns

Type	Description
EqualNumericConstraint<decimal>

View Source

EqualTo(double)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<double> EqualTo(double expected)

Parameters

Type	Name	Description
double	expected

Returns

Type	Description
EqualNumericConstraint<double>

View Source

EqualTo(short)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<short> EqualTo(short expected)

Parameters

Type	Name	Description
short	expected

Returns

Type	Description
EqualNumericConstraint<short>

View Source

EqualTo(int)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<int> EqualTo(int expected)

Parameters

Type	Name	Description
int	expected

Returns

Type	Description
EqualNumericConstraint<int>

View Source

EqualTo(long)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<long> EqualTo(long expected)

Parameters

Type	Name	Description
long	expected

Returns

Type	Description
EqualNumericConstraint<long>

View Source

EqualTo(object?)

Returns a constraint that tests two items for equality

Declaration

public static EqualConstraint EqualTo(object? expected)

Parameters

Type	Name	Description
object	expected

Returns

Type	Description
EqualConstraint

View Source

EqualTo(sbyte)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<sbyte> EqualTo(sbyte expected)

Parameters

Type	Name	Description
sbyte	expected

Returns

Type	Description
EqualNumericConstraint<sbyte>

View Source

EqualTo(float)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<float> EqualTo(float expected)

Parameters

Type	Name	Description
float	expected

Returns

Type	Description
EqualNumericConstraint<float>

View Source

EqualTo(string?)

Returns a constraint that tests two strings for equality

Declaration

public static EqualStringConstraint EqualTo(string? expected)

Parameters

Type	Name	Description
string	expected

Returns

Type	Description
EqualStringConstraint

View Source

EqualTo(TimeSpan)

Returns a constraint that tests two timespan instances for equality.

Declaration

public static EqualTimeBaseConstraint<TimeSpan> EqualTo(TimeSpan expected)

Parameters

Type	Name	Description
TimeSpan	expected

Returns

Type	Description
EqualTimeBaseConstraint<TimeSpan>

View Source

EqualTo(ushort)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<ushort> EqualTo(ushort expected)

Parameters

Type	Name	Description
ushort	expected

Returns

Type	Description
EqualNumericConstraint<ushort>

View Source

EqualTo(uint)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<uint> EqualTo(uint expected)

Parameters

Type	Name	Description
uint	expected

Returns

Type	Description
EqualNumericConstraint<uint>

View Source

EqualTo(ulong)

Returns a constraint that tests two numbers for equality

Declaration

public static EqualNumericConstraint<ulong> EqualTo(ulong expected)

Parameters

Type	Name	Description
ulong	expected

Returns

Type	Description
EqualNumericConstraint<ulong>

View Source

EqualTo<T>(IEnumerable<T>?)

Returns a constraint that tests two collections for equality.

Declaration

public static EqualConstraint EqualTo<T>(IEnumerable<T>? expected)

Parameters

Type	Name	Description
IEnumerable<T>	expected

Returns

Type	Description
EqualConstraint

Type Parameters

Name	Description
T

View Source

EqualTo<T>(T?)

Returns a constraint that tests two items for equality

Declaration

public static EqualConstraint EqualTo<T>(T? expected)

Parameters

Type	Name	Description
T	expected

Returns

Type	Description
EqualConstraint

Type Parameters

Name	Description
T

View Source

EquivalentTo(IEnumerable)

Returns a constraint that tests whether the actual value is a collection containing the same elements as the collection supplied as an argument.

Declaration

public static CollectionEquivalentConstraint EquivalentTo(IEnumerable expected)

Parameters

Type	Name	Description
IEnumerable	expected

Returns

Type	Description
CollectionEquivalentConstraint

View Source

EquivalentTo<T>(IEnumerable<T>)

Returns a constraint that tests whether the actual value is a collection containing the same elements as the collection supplied as an argument.

Declaration

public static CollectionEquivalentConstraint EquivalentTo<T>(IEnumerable<T> expected)

Parameters

Type	Name	Description
IEnumerable<T>	expected

Returns

Type	Description
CollectionEquivalentConstraint

Type Parameters

Name	Description
T

View Source

GreaterThan(object)

Returns a constraint that tests whether the actual value is greater than the supplied argument

Declaration

public static GreaterThanConstraint GreaterThan(object expected)

Parameters

Type	Name	Description
object	expected

Returns

Type	Description
GreaterThanConstraint

View Source

GreaterThanOrEqualTo(object)

Returns a constraint that tests whether the actual value is greater than or equal to the supplied argument

Declaration

public static GreaterThanOrEqualConstraint GreaterThanOrEqualTo(object expected)

Parameters

Type	Name	Description
object	expected

Returns

Type	Description
GreaterThanOrEqualConstraint

View Source

InRange(object, object)

Returns a constraint that tests whether the actual value falls inclusively within a specified range.

Declaration

public static RangeConstraint InRange(object from, object to)

Parameters

Type	Name	Description
object	from	Inclusive beginning of the range.
object	to	Inclusive end of the range.

Returns

Type	Description
RangeConstraint

View Source

InstanceOf(Type)

Returns a constraint that tests whether the actual value is of the type supplied as an argument or a derived type.

Declaration

public static InstanceOfTypeConstraint InstanceOf(Type expectedType)

Parameters

Type	Name	Description
Type	expectedType

Returns

Type	Description
InstanceOfTypeConstraint

View Source

InstanceOf<TExpected>()

Returns a constraint that tests whether the actual value is of the type supplied as an argument or a derived type.

Declaration

public static InstanceOfTypeConstraint InstanceOf<TExpected>()

Returns

Type	Description
InstanceOfTypeConstraint

Type Parameters

Name	Description
TExpected

View Source

LessThan(object)

Returns a constraint that tests whether the actual value is less than the supplied argument

Declaration

public static LessThanConstraint LessThan(object expected)

Parameters

Type	Name	Description
object	expected

Returns

Type	Description
LessThanConstraint

View Source

LessThanOrEqualTo(object)

Returns a constraint that tests whether the actual value is less than or equal to the supplied argument

Declaration

public static LessThanOrEqualConstraint LessThanOrEqualTo(object expected)

Parameters

Type	Name	Description
object	expected

Returns

Type	Description
LessThanOrEqualConstraint

View Source

SameAs(object?)

Returns a constraint that tests that two references are the same object

Declaration

public static SameAsConstraint SameAs(object? expected)

Parameters

Type	Name	Description
object	expected

Returns

Type	Description
SameAsConstraint

View Source

SamePath(string)

Returns a constraint that tests whether the path provided is the same as an expected path after canonicalization.

Declaration

public static SamePathConstraint SamePath(string expected)

Parameters

Type	Name	Description
string	expected

Returns

Type	Description
SamePathConstraint

View Source

SamePathOrUnder(string)

Returns a constraint that tests whether the path provided is the same path or under an expected path after canonicalization.

Declaration

public static SamePathOrUnderConstraint SamePathOrUnder(string expected)

Parameters

Type	Name	Description
string	expected

Returns

Type	Description
SamePathOrUnderConstraint

View Source

SubPathOf(string)

Returns a constraint that tests whether the path provided is a subpath of the expected path after canonicalization.

Declaration

public static SubPathConstraint SubPathOf(string expected)

Parameters

Type	Name	Description
string	expected

Returns

Type	Description
SubPathConstraint

View Source

SubsetOf(IEnumerable)

Returns a constraint that tests whether the actual value is a subset of the collection supplied as an argument.

Declaration

public static CollectionSubsetConstraint SubsetOf(IEnumerable expected)

Parameters

Type	Name	Description
IEnumerable	expected

Returns

Type	Description
CollectionSubsetConstraint

View Source

SubsetOf<T>(IEnumerable<T>)

Returns a constraint that tests whether the actual value is a subset of the collection supplied as an argument.

Declaration

public static CollectionSubsetConstraint SubsetOf<T>(IEnumerable<T> expected)

Parameters

Type	Name	Description
IEnumerable<T>	expected

Returns

Type	Description
CollectionSubsetConstraint

Type Parameters

Name	Description
T

View Source

SupersetOf(IEnumerable)

Returns a constraint that tests whether the actual value is a superset of the collection supplied as an argument.

Declaration

public static CollectionSupersetConstraint SupersetOf(IEnumerable expected)

Parameters

Type	Name	Description
IEnumerable	expected

Returns

Type	Description
CollectionSupersetConstraint

View Source

SupersetOf<T>(IEnumerable<T>)

Returns a constraint that tests whether the actual value is a superset of the collection supplied as an argument.

Declaration

public static CollectionSupersetConstraint SupersetOf<T>(IEnumerable<T> expected)

Parameters

Type	Name	Description
IEnumerable<T>	expected

Returns

Type	Description
CollectionSupersetConstraint

Type Parameters

Name	Description
T

View Source

TypeOf(Type)

Returns a constraint that tests whether the actual value is of the exact type supplied as an argument.

Declaration

public static ExactTypeConstraint TypeOf(Type expectedType)

Parameters

Type	Name	Description
Type	expectedType

Returns

Type	Description
ExactTypeConstraint

View Source

TypeOf<TExpected>()

Returns a constraint that tests whether the actual value is of the exact type supplied as an argument.

Declaration

public static ExactTypeConstraint TypeOf<TExpected>()

Returns

Type	Description
ExactTypeConstraint

Type Parameters

Name	Description
TExpected