Class EventuallyOptions

Namespace

XBullet.EasyTesting

Assembly

XBullet.EasyTesting.dll

Configures sequential polling for eventual assertions and conditions.

public sealed class EventuallyOptions

Inheritance

object

EventuallyOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

SnapshotAssertionExtensions.ShouldMatchSnapshot(object?, Action<SnapshotSettings>, CancellationToken, string, string)

SnapshotAssertionExtensions.ShouldMatchSnapshot(object?, string, CancellationToken, string, string)

SnapshotAssertionExtensions.ShouldMatchSnapshot(object?, SnapshotSettings?, CancellationToken, string, string)

Properties

Description

Gets an optional description included in timeout diagnostics.

public string? Description { get; init; }

Property Value

string

The expected eventual behavior, or null.

PollInterval

Gets the delay between completed attempts.

public TimeSpan PollInterval { get; init; }

Property Value

TimeSpan

A positive duration, defaulting to fifty milliseconds.

ShouldRetry

Gets an optional filter for assertion failures that should be retried.

public Func<Exception, bool>? ShouldRetry { get; init; }

Property Value

Func<Exception, bool>

A filter, or null to retry every non-cancellation assertion failure.

Remarks

Conditions never retry exceptions. Cancellation exceptions are never passed to this filter.

TimeProvider

Gets the clock used for deadlines, elapsed time, and polling delays.

public TimeProvider TimeProvider { get; init; }

Property Value

TimeProvider

The time provider, defaulting to the system clock.

Timeout

Gets the maximum cooperative wait duration.

public TimeSpan Timeout { get; init; }

Property Value

TimeSpan

A positive duration, defaulting to five seconds.