Xceed Logo
Shop
Fluent Assertions Documentation
FluentAssertions Assembly / FluentAssertions.Formatting Namespace / Formatter Class
In This Topic
    Formatter Class
    In This Topic
    Provides services for formatting an object being used in an assertion in a human-readable format.
    Syntax
    public static class Formatter
    Inheritance Hierarchy

    System.Object
       FluentAssertions.Formatting.Formatter

    Public Properties
     NameDescription
    Public Propertystatic (Shared in Visual Basic)Formatters A list of objects responsible for formatting the objects represented by placeholders.  
    Top
    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic)AddFormatter Ensures a custom formatter is included in the chain, just before the default formatter is executed.  
    Public Methodstatic (Shared in Visual Basic)RemoveFormatterRemoves a custom formatter that was previously added through AddFormatter.  
    Public Methodstatic (Shared in Visual Basic)ToStringOverloaded.  Returns a human-readable representation of a particular object.  
    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

    Formatter Members
    FluentAssertions.Formatting Namespace

    Send Feedback