Xceed Logo
Shop
Fluent Assertions Documentation
FluentAssertions Assembly / FluentAssertions.Numeric Namespace / ComparableTypeAssertions<T,TAssertions> Class
In This Topic
    ComparableTypeAssertions<T,TAssertions> Class
    In This Topic
    Contains a number of methods to assert that an IComparable is in the expected state.
    Object Model
    ComparableTypeAssertions<T,TAssertions> ClassAssertionChain Class
    Syntax
    [DebuggerNonUserCode()]
public class ComparableTypeAssertions<T,TAssertions> : FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions> 
where TAssertions: ComparableTypeAssertions<T,TAssertions>
    Type Parameters
    T
    TAssertions
    Inheritance Hierarchy

    System.Object
       FluentAssertions.Primitives.ReferenceTypeAssertions<TSubject,TAssertions>
          FluentAssertions.Numeric.ComparableTypeAssertions<T,TAssertions>
             FluentAssertions.Numeric.ComparableTypeAssertions<T>

    Public Constructors
     NameDescription
    Public ConstructorComparableTypeAssertions<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<IComparable<T>,TAssertions>)
    Public PropertySubject Gets the object whose value is being asserted. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,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 MethodBeAsserts that an object equals another object using its System.Object.Equals(System.Object) implementation.
    Verification whether CompareTo returns 0 is not done here, you should use BeRankedEquallyTo to verify this.  
    Public MethodBeAssignableToOverloaded. Asserts that the object is assignable to a variable of type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    Public MethodBeEquivalentToOverloaded.  Asserts that an object is equivalent to another object.  
    Public MethodBeGreaterThanAsserts that the subject is greater than another object according to its implementation of IComparable.  
    Public MethodBeGreaterThanOrEqualToAsserts that the subject is greater than or equal to another object according to its implementation of IComparable.  
    Public MethodBeInRange Asserts that a value is within a range.  
    Public MethodBeLessThanAsserts that the subject is less than another object according to its implementation of IComparable.  
    Public MethodBeLessThanOrEqualToAsserts that the subject is less than or equal to another object according to its implementation of IComparable.  
    Public MethodBeNull Asserts that the current object has not been initialized yet. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    Public MethodBeOfTypeOverloaded. Asserts that the object is of the specified type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    Public MethodBeOneOfOverloaded. Asserts that a value is one of the specified validValues.  
    Public MethodBeRankedEquallyToAsserts that the subject is ranked equal to another object. I.e. the result of CompareTo returns 0. To verify whether the objects are equal you must use Be.  
    Public MethodBeSameAs Asserts that an object reference refers to the exact same object as another object reference. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    Public MethodEquals (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    Public MethodMatchOverloaded. Asserts that the predicate is satisfied. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    Public MethodNotBeAsserts that an object does not equal another object using its System.Object.Equals(System.Object) method.
    Verification whether CompareTo returns non-zero is not done here, you should use NotBeRankedEquallyTo to verify this.  
    Public MethodNotBeAssignableToOverloaded. Asserts that the object is not assignable to a variable of type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    Public MethodNotBeInRange Asserts that a value is not within a range.  
    Public MethodNotBeNull Asserts that the current object has been initialized. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    Public MethodNotBeOfTypeOverloaded. Asserts that the object is not of the specified type T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    Public MethodNotBeRankedEquallyToAsserts that the subject is not ranked equal to another object. I.e. the result of CompareToreturns non-zero. To verify whether the objects are not equal according to System.Object.Equals(System.Object) you must use NotBe.  
    Public MethodNotBeSameAs Asserts that an object reference refers to a different object than another object reference refers to. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    Public MethodSatisfy<T>Allows combining one or more assertions using the other assertion methods that this library offers on an instance of T. (Inherited from FluentAssertions.Primitives.ReferenceTypeAssertions<IComparable<T>,TAssertions>)
    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

    ComparableTypeAssertions<T,TAssertions> Members
    FluentAssertions.Numeric Namespace
    IComparable

    Send Feedback