Class NotEqualException

Namespace

Xunit.Sdk

Assembly

xunit.v3.assert.dll

Exception thrown when Assert.NotEqual fails.

public class NotEqualException : XunitException, ISerializable, IAssertionException

Inheritance

object

Exception

XunitException

NotEqualException

Implements

ISerializable

IAssertionException

Inherited Members

XunitException.ToString()

Exception.GetBaseException()

Exception.GetObjectData(SerializationInfo, StreamingContext)

Exception.GetType()

Exception.Data

Exception.HelpLink

Exception.HResult

Exception.InnerException

Exception.Message

Exception.Source

Exception.StackTrace

Exception.TargetSite

Exception.SerializeObjectState

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Methods

ForEqualCollections(string, string, string?)

Creates a new instance of NotEqualException to be thrown when two collections are equal.

public static NotEqualException ForEqualCollections(string expected, string actual, string? collectionDisplay = null)

Parameters

expected string

The expected collection

actual string

The actual collection

collectionDisplay string

The display name for the collection type (defaults to "Collections")

Returns

NotEqualException

ForEqualCollectionsWithError(int?, string, int?, string, int?, Exception?, string?)

Creates a new instance of NotEqualException to be thrown when two collections are equal, and an error has occurred during comparison.

public static NotEqualException ForEqualCollectionsWithError(int? mismatchedIndex, string expected, int? expectedPointer, string actual, int? actualPointer, Exception? error = null, string? collectionDisplay = null)

Parameters

mismatchedIndex int?

The index at which the collections error occurred (should be null when error is null)

expected string

The expected collection

expectedPointer int?

The spacing into the expected collection where the difference occurs (should be null when error is null)

actual string

The actual collection

actualPointer int?

The spacing into the actual collection where the difference occurs (should be null when error is null)

error Exception

The optional exception that was thrown during comparison

collectionDisplay string

The display name for the collection type (defaults to "Collections")

Returns

NotEqualException

ForEqualValues(string, string, string?)

Creates a new instance of NotEqualException to be thrown when two values are equal. This may be simple values (like intrinsics) or complex values (like classes or structs).

public static NotEqualException ForEqualValues(string expected, string actual, string? banner = null)

Parameters

expected string

The expected value

actual string

The actual value

banner string

The banner to show; if null, then the standard banner of "Values are equal" will be used

Returns

NotEqualException

ForEqualValuesWithError(string, string, Exception?, string?)

Creates a new instance of NotEqualException to be thrown when two values are equal. This may be simple values (like intrinsics) or complex values (like classes or structs). Used when an error has occurred during comparison.

public static NotEqualException ForEqualValuesWithError(string expected, string actual, Exception? error = null, string? banner = null)

Parameters

expected string

The expected value

actual string

The actual value

error Exception

The optional exception that was thrown during comparison

banner string

The banner to show; if null, then the standard banner of "Values are equal" will be used. If error is not null, then the banner used will always be "Exception thrown during comparison", regardless of the value passed here.

Returns

NotEqualException