Xceed Logo
Shop
Fluent Assertions Documentation
FluentAssertions Assembly / FluentAssertions.Collections Namespace / GenericCollectionAssertions<TCollection,T,TAssertions> Class
In This Topic
    GenericCollectionAssertions<TCollection,T,TAssertions> Class
    In This Topic
    Object Model
    GenericCollectionAssertions<TCollection,T,TAssertions> ClassAssertionChain Class
    Syntax
    [DebuggerNonUserCode()]
public class GenericCollectionAssertions<TCollection,T,TAssertions> : FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions> 
where TCollection: IEnumerable<T>
where TAssertions: GenericCollectionAssertions<TCollection,T,TAssertions>
    Type Parameters
    TCollection
    T
    TAssertions
    Inheritance Hierarchy

    System.Object
       FluentAssertions.Primitives.ReferenceTypeAssertions<TSubject,TAssertions>
          FluentAssertions.Collections.GenericCollectionAssertions<TCollection,T,TAssertions>
             FluentAssertions.Collections.GenericCollectionAssertions<T>
             FluentAssertions.Collections.GenericCollectionAssertions<TCollection,T>
             FluentAssertions.Collections.GenericDictionaryAssertions<TCollection,TKey,TValue,TAssertions>
             FluentAssertions.Collections.StringCollectionAssertions<TCollection,TAssertions>

    Public Constructors
     NameDescription
    Public ConstructorGenericCollectionAssertions<TCollection,T,TAssertions> Constructor  
    Top
    Public Properties
     NameDescription
    Public PropertyCurrentAssertionChainProvides access to the FluentAssertions.Execution.AssertionChain that this assertion class was initialized with. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Public PropertySubject Gets the object whose value is being asserted. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Top
    Protected Properties
     NameDescription
    Protected PropertyIdentifierOverridden.  Returns the type of the subject the assertion applies on. It should be a user-friendly name as it is included in the failure message. Returns the type of the subject the assertion applies on.  
    Top
    Public Methods
     NameDescription
    Public MethodAllBeAssignableToOverloaded. Asserts that all items in the collection are of the specified type TExpectation  
    Public MethodAllBeEquivalentToOverloaded.  Asserts that all elements in a collection of objects are equivalent to a given object.  
    Public MethodAllBeOfTypeOverloaded. Asserts that all items in the collection are of the exact specified type TExpectation  
    Public MethodAllSatisfy Asserts that a collection contains only items which meet the criteria provided by the inspector.  
    Public MethodBeAssignableToOverloaded. Asserts that the object is assignable to a variable of type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Public MethodBeEmpty Asserts that the collection does not contain any items.  
    Public MethodBeEquivalentToOverloaded.  Asserts that a collection of objects is equivalent to another collection of objects.  
    Public MethodBeInAscendingOrderOverloaded. Asserts that a collection is ordered in ascending order according to the value of the specified propertyExpression.  
    Public MethodBeInDescendingOrderOverloaded. Asserts that a collection is ordered in descending order according to the value of the specified propertyExpression.  
    Public MethodBeNull Asserts that the current object has not been initialized yet. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Public MethodBeNullOrEmpty Asserts that the collection is null or does not contain any items.  
    Public MethodBeOfTypeOverloaded. Asserts that the object is of the specified type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Public MethodBeSameAs Asserts that an object reference refers to the exact same object as another object reference. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Public MethodBeSubsetOfAsserts that the collection is a subset of the expectedSuperset.  
    Public MethodContainOverloaded.  Asserts that the collection contains the specified item.  
    Public MethodContainEquivalentOfOverloaded. Asserts that at least one element in the collection is equivalent to expectation.  
    Public MethodContainInConsecutiveOrderOverloaded. Expects the current collection to contain the specified elements in the exact same order, and to be consecutive. using their System.Object.Equals(System.Object) implementation.  
    Public MethodContainInOrderOverloaded. Expects the current collection to contain the specified elements in the exact same order, not necessarily consecutive. using their System.Object.Equals(System.Object) implementation.  
    Public MethodContainItemsAssignableTo<TExpectation>Asserts that the current collection contains at least one element that is assignable to the type TExpectation.  
    Public MethodContainSingleOverloaded.  Expects the current collection to contain only a single item.  
    Public MethodEndWithOverloaded. Asserts that the current collection ends with same elements in the same order as the collection identified by expectation. Elements are compared using their System.Object.Equals(System.Object).  
    Public MethodEqualOverloaded. Expects the current collection to contain all the same elements in the same order as the collection identified by elements. Elements are compared using their System.Object.Equals(System.Object) method.  
    Public MethodEqualsOverridden.   
    Public MethodHaveCountOverloaded. Asserts that the number of items in the collection matches the supplied expected amount.  
    Public MethodHaveCountGreaterThanAsserts that the number of items in the collection is greater than the supplied expected amount.  
    Public MethodHaveCountGreaterThanOrEqualToAsserts that the number of items in the collection is greater than or equal to the supplied expected amount.  
    Public MethodHaveCountLessThanAsserts that the number of items in the collection is less than the supplied expected amount.  
    Public MethodHaveCountLessThanOrEqualToAsserts that the number of items in the collection is less than or equal to the supplied expected amount.  
    Public MethodHaveElementAtAsserts that the current collection has the supplied element at the supplied index.  
    Public MethodHaveElementPrecedingAsserts that the expectation element directly precedes the successor.  
    Public MethodHaveElementSucceedingAsserts that the expectation element directly succeeds the predecessor.  
    Public MethodHaveSameCount<TExpectation>Assert that the current collection has the same number of elements as otherCollection.  
    Public MethodIntersectWithAsserts that the collection shares one or more items with the specified otherCollection.  
    Public MethodMatchOverloaded. Asserts that the predicate is satisfied. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Public MethodNotBeAssignableToOverloaded. Asserts that the object is not assignable to a variable of type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Public MethodNotBeEmpty Asserts that the collection contains at least 1 item.  
    Public MethodNotBeEquivalentToOverloaded. Expects the current collection not to contain all elements of the collection identified by unexpected, regardless of the order. Elements are compared using their System.Object.Equals(System.Object).  
    Public MethodNotBeInAscendingOrderOverloaded. Asserts that a collection is not ordered in ascending order according to the value of the specified propertyExpression.  
    Public MethodNotBeInDescendingOrderOverloaded. Asserts that a collection is not ordered in descending order according to the value of the specified propertyExpression.  
    Public MethodNotBeNull Asserts that the current object has been initialized. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Public MethodNotBeNullOrEmpty Asserts that the collection is not null and contains at least 1 item.  
    Public MethodNotBeOfTypeOverloaded. Asserts that the object is not of the specified type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Public MethodNotBeSameAs Asserts that an object reference refers to a different object than another object reference refers to. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<TCollection,TAssertions>)
    Public MethodNotBeSubsetOfAsserts that the collection is not a subset of the unexpectedSuperset.  
    Public MethodNotContainOverloaded. Asserts that the current collection does not contain the supplied unexpected item.  
    Public MethodNotContainEquivalentOfOverloaded. Asserts that no element in the collection is equivalent to unexpected.  
    Public MethodNotContainInConsecutiveOrderOverloaded.  Asserts the current collection does not contain the specified elements in the exact same order and are consecutive.  
    Public MethodNotContainInOrderOverloaded.  Asserts the current collection does not contain the specified elements in the exact same order, not necessarily consecutive.  
    Public MethodNotContainItemsAssignableToOverloaded. Asserts that the current collection does not contain any elements that are assignable to the type TExpectation.  
    Public MethodNotContainNullsOverloaded. Asserts that the collection does not contain any a null reference (Nothing in Visual Basic) items.  
    Public MethodNotEqualExpects the current collection not to contain all the same elements in the same order as the collection identified by unexpected. Elements are compared using their System.Object.Equals(System.Object).  
    Public MethodNotHaveCountAsserts that the number of items in the collection does not match the supplied unexpected amount.  
    Public MethodNotHaveSameCount<TExpectation>Assert that the current collection does not have the same number of elements as otherCollection.  
    Public MethodNotIntersectWithAsserts that the collection does not share any items with the specified otherCollection.  
    Public MethodOnlyContain Asserts that the collection only contains items that match a predicate.  
    Public MethodOnlyHaveUniqueItemsOverloaded.  Asserts that the collection does not contain any duplicate items.  
    Public MethodSatisfyOverloaded.  Asserts that a collection contains exactly a given number of elements which meet the criteria provided by the element predicates. Assertion fails if it is not possible to find a one-to-one mapping between the elements of the collection and the predicates. The order of the predicates does not need to match the order of the elements.  
    Public MethodSatisfyRespectivelyOverloaded.  Asserts that a collection contains exactly a given number of elements, which meet the criteria provided by the element inspectors.  
    Public MethodStartWithOverloaded. Asserts that the current collection starts with same elements in the same order as the collection identified by expectation. Elements are compared using their System.Object.Equals(System.Object).  
    Top
    Protected Methods
     NameDescription
    Protected MethodAssertCollectionEndsWith<TActual,TExpectation>  
    Protected MethodAssertCollectionStartsWith<TActual,TExpectation>  
    Protected MethodAssertSubjectEquality<TExpectation>  
    Protected Methodstatic (Shared in Visual Basic)RepeatAsManyAs<TExpectation>  
    Top
    Extension Methods
     NameDescription
    Public Extension MethodAs<TTo>Safely casts the specified object to the type specified through TTo.
    Public Extension MethodAwaitingOverloaded. Invokes the specified action on a subject so that you can chain it with any of the assertions from FluentAssertions.Specialized.NonGenericAsyncFunctionAssertions
    Public Extension MethodEnumeratingOverloaded. Forces enumerating a collection. Should be used to assert that a method that uses the yield keyword throws a particular exception.
    Public Extension MethodExecutionTimeOf<T> Provides methods for asserting the execution time of a method or property.
    Public Extension MethodInvokingOverloaded. Invokes the specified action on a subject so that you can chain it with any of the assertions from FluentAssertions.Specialized.ActionAssertions
    Public Extension MethodMonitorOverloaded. Starts monitoring eventSource for its events.
    Public Extension MethodShouldOverloaded. Returns an FluentAssertions.Specialized.ExecutionTimeAssertions object that can be used to assert the current FluentAssertions.Specialized.ExecutionTime.
    Public Extension MethodShouldOverloaded. Returns an FluentAssertions.Primitives.EnumAssertions<TEnum,TAssertions> object that can be used to assert the current TEnum.
    Top
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    GenericCollectionAssertions<TCollection,T,TAssertions> Members
    FluentAssertions.Collections Namespace

    Send Feedback