Xceed Logo
Shop
Fluent Assertions Documentation
FluentAssertions Assembly / FluentAssertions.Execution Namespace / AssertionScope Class
In This Topic
    AssertionScope Class
    In This Topic
    Represents an implicit or explicit scope within which multiple assertions can be collected.
    Object Model
    AssertionScope ClassAssertionScope ClassFormattingOptions Class
    Syntax
    public sealed class AssertionScope : System.IDisposable
    Remarks
    This class is supposed to have a very short lifetime and is not safe to be used in assertion that cross thread-boundaries such as when using async or await.
    Inheritance Hierarchy

    System.Object
       FluentAssertions.Execution.AssertionScope

    Public Constructors
     NameDescription
    Public ConstructorAssertionScope ConstructorOverloaded.  Represents an implicit or explicit scope within which multiple assertions can be collected.  
    Top
    Public Properties
     NameDescription
    Public Propertystatic (Shared in Visual Basic)Current Gets the current thread-specific assertion scope.  
    Public PropertyFormattingOptions Exposes the options the scope will use for formatting objects in case an assertion fails.  
    Public PropertyName Gets or sets the name of the current assertion scope, e.g. the path of the object graph that is being asserted on.  
    Top
    Public Methods
     NameDescription
    Public MethodAddPreFormattedFailure Adds a pre-formatted failure message to the current scope.  
    Public MethodAppendTracing Adds a block of tracing to the scope for reporting when an assertion fails.  
    Public MethodDiscardReturns all failures that happened up to this point and ensures they will not cause Dispose to fail the assertion.  
    Public MethodDispose  
    Public MethodHasFailures  
    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

    AssertionScope Members
    FluentAssertions.Execution Namespace

    Send Feedback