Xceed Logo
Shop
Fluent Assertions Documentation
FluentAssertions Assembly / FluentAssertions.Equivalency Namespace / SelfReferenceEquivalencyOptions<TSelf> Class
In This Topic
    SelfReferenceEquivalencyOptions<TSelf> Class
    In This Topic
    Represents the run-time behavior of a structural equivalency assertion.
    Object Model
    SelfReferenceEquivalencyOptions<TSelf> ClassConversionSelector ClassOrderingRuleCollection ClassITraceWriter Interface
    Syntax
    public abstract class SelfReferenceEquivalencyOptions<TSelf> : IEquivalencyOptions  
where TSelf: SelfReferenceEquivalencyOptions<TSelf>
    Type Parameters
    TSelf
    Inheritance Hierarchy

    System.Object
       FluentAssertions.Equivalency.SelfReferenceEquivalencyOptions<TSelf>
          FluentAssertions.Equivalency.EquivalencyOptions
          FluentAssertions.Equivalency.EquivalencyOptions<TExpectation>

    Public Properties
     NameDescription
    Public PropertyCompareRecordsByValue  
    Public PropertyConversionSelector  
    Public PropertyIgnoreCase  
    Public PropertyIgnoreJsonPropertyCasing  
    Public PropertyIgnoreLeadingWhitespace  
    Public PropertyIgnoreNewlineStyle  
    Public PropertyIgnoreTrailingWhitespace  
    Public PropertyIncludeFullStringsInDifference  
    Public PropertyTraceWriter  
    Top
    Protected Properties
     NameDescription
    Protected PropertyOrderingRules  
    Top
    Public Methods
     NameDescription
    Public MethodAllowingInfiniteRecursion Disables limitations on recursion depth when the structural equality check is configured to include nested objects  
    Public MethodComparingByMembersOverloaded. Marks the T as a type that should be compared by its members even though it may override the System.Object.Equals(System.Object) method.  
    Public MethodComparingByValueOverloaded. Marks the T as a value type which must be compared using its System.Object.Equals(System.Object) method, regardless of it overriding it or not.  
    Public MethodComparingEnumsByName Causes to compare Enum properties using the result of their ToString method.  
    Public MethodComparingEnumsByValue Causes to compare Enum members using their underlying value only.  
    Public MethodComparingRecordsByMembersEnsures records by default are compared by their members even though they override the System.Object.Equals(System.Object) method.  
    Public MethodComparingRecordsByValue Ensures records by default are compared by value instead of their members.  
    Public MethodExcluding Excludes a (nested) property based on a predicate from the structural equality check.  
    Public MethodExcludingExplicitlyImplementedProperties Excludes properties that are explicitly implemented from the equivalency comparison.  
    Public MethodExcludingFields Instructs the comparison to exclude fields.  
    Public MethodExcludingMembersNamed Excludes the specified member(s) from the structural equality check anywhere in the object graph.  
    Public MethodExcludingMissingMembers Tries to match the members of the expectation with equally named members on the subject. Ignores those members that don't exist on the subject and previously registered matching rules.  
    Public MethodExcludingNonBrowsableMembersInstructs the comparison to exclude non-browsable members in the expectation (members set to System.ComponentModel.EditorBrowsableState.Never). It is not required that they be marked non-browsable in the subject. Use IgnoringNonBrowsableMembersOnSubject to ignore non-browsable members in the subject.  
    Public MethodExcludingProperties Instructs the comparison to exclude properties.  
    Public MethodIgnoringCaseInstructs the comparison to compare strings case-insensitive.  
    Public MethodIgnoringCyclicReferences Causes the structural equality check to ignore any cyclic references.  
    Public MethodIgnoringJsonPropertyCasing Tells the comparison to ignore the casing when trying to match a property to a JSON property.  
    Public MethodIgnoringLeadingWhitespaceInstructs the comparison to ignore leading whitespace when comparing strings.  
    Public MethodIgnoringNonBrowsableMembersOnSubjectInstructs the comparison to treat non-browsable members in the subject as though they do not exist. If you need to ignore non-browsable members in the expectation, use ExcludingNonBrowsableMembers.  
    Public MethodIgnoringTrailingWhitespaceInstructs the comparison to ignore trailing whitespace when comparing strings.  
    Public MethodIncluding Includes the specified member in the equality check.  
    Public MethodIncludingAllDeclaredProperties Causes inclusion of only public properties of the subject as far as they are defined on the declared type.  
    Public MethodIncludingAllRuntimeProperties Causes inclusion of only public properties of the subject based on its run-time type rather than its declared type.  
    Public MethodIncludingFields Instructs the comparison to include public fields.  
    Public MethodIncludingFullStringsInDifference Tells the comparison to include the full string values of the subject and expectation instead of just the fragment that differs.  
    Public MethodIncludingInternalFields Instructs the comparison to include public and internal fields.  
    Public MethodIncludingInternalProperties Instructs the comparison to include public and internal properties.  
    Public MethodIncludingNestedObjects Causes the structural equality comparison to recursively traverse the object graph and compare the fields and properties of any nested objects and objects in collections.  
    Public MethodIncludingProperties Instructs the comparison to include public properties.  
    Public MethodPreferringDeclaredMemberTypes Instructs the structural equality comparison to prefer the declared types of the members when executing assertions.  
    Public MethodPreferringRuntimeMemberTypes Instructs the structural equality comparison to use the run-time types of the members to drive the assertion.  
    Public MethodThrowingOnMissingMembers Requires the subject to have members which are equally named to members on the expectation.  
    Public MethodToString Returns a string that represents the current object.  
    Public MethodUsingOverloaded. Overrides the comparison of subject and expectation to use provided action when the predicate is met.  
    Public MethodWithAutoConversion Instructs the equivalency comparison to try to convert the values of matching properties before running any of the other steps.  
    Public MethodWithAutoConversionFor Instructs the equivalency comparison to try to convert the value of a specific member on the expectation object before running any of the other steps.  
    Public MethodWithoutAutoConversionFor Instructs the equivalency comparison to prevent trying to convert the value of a specific member on the expectation object before running any of the other steps.  
    Public MethodWithoutMatchingRules Clears all matching rules, including those that were added by default.  
    Public MethodWithoutRecursing Stops the structural equality check from recursively comparing the members of any nested objects.  
    Public MethodWithoutSelectionRules Clears all selection rules, including those that were added by default.  
    Public MethodWithoutStrictOrdering Causes all collections - except bytes - to be compared ignoring the order in which the items appear in the expectation.  
    Public MethodWithoutStrictOrderingForCauses the collection identified by the provided predicate to be compared ignoring the order in which the items appear in the expectation.  
    Public MethodWithoutStrictTyping Disables the strict typing requirement for all members, allowing members in the expectation to be of different types than members in the subject.  
    Public MethodWithStrictOrdering Causes all collections to be compared in the order in which the items appear in the expectation.  
    Public MethodWithStrictOrderingForCauses the collection identified by the provided predicate to be compared in the order in which the items appear in the expectation.  
    Public MethodWithStrictTyping Causes all type comparisons to be strict, requiring exact type equality between subject and expectation.  
    Public MethodWithStrictTypingForCauses the types identified by the provided predicate to be compared using strict typing, requiring exact type equality.  
    Public MethodWithTracing Enables tracing the steps the equivalency validation followed to compare two graphs.  
    Top
    Protected Methods
     NameDescription
    Protected MethodAddMatchingRule  
    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.
    Public Extension MethodShouldOverloaded. Returns an object that provides various assertion APIs that act on a System.Text.Json.Nodes.JsonNode.
    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

    SelfReferenceEquivalencyOptions<TSelf> Members
    FluentAssertions.Equivalency Namespace

    Send Feedback