Header menu logo testify

CheckFailure<'Args, 'Actual, 'Expected> Type

Structured information describing a failing property-style test case.

Record fields

Record Field Description

Actual

Full Usage: Actual

Field type: string

The rendered actual/tested side shown in failure output.

Field type: string

ActualValueDisplay

Full Usage: ActualValueDisplay

Field type: string option

The raw rendered actual value, when Testify can provide one separately.

Field type: string option

Because

Full Usage: Because

Field type: string option

An optional explanation describing why the values or observations differ.

Field type: string option

Description

Full Usage: Description

Field type: string

The human-readable expectation description recorded for the failure.

Field type: string

Details

Full Usage: Details

Field type: FailureDetails option

Optional structured nested details used by rich renderers.

Field type: FailureDetails option

Expected

Full Usage: Expected

Field type: string

The rendered expected/reference side shown in failure output.

Field type: string

ExpectedValueDisplay

Full Usage: ExpectedValueDisplay

Field type: string option

The raw rendered expected value, when Testify can provide one separately.

Field type: string option

Label

Full Usage: Label

Field type: string

The stable expectation label recorded for the failure.

Field type: string

NumberOfShrinks

Full Usage: NumberOfShrinks

Field type: int option

The number of shrinking steps applied to reach the final counterexample.

Field type: int option

NumberOfTests

Full Usage: NumberOfTests

Field type: int option

The number of generated tests executed before the failure was reported.

Field type: int option

Original

Full Usage: Original

Field type: CheckCase<'Args, 'Actual, 'Expected>

The original unshrunk failing case before FsCheck shrinking.

Field type: CheckCase<'Args, 'Actual, 'Expected>

Replay

Full Usage: Replay

Field type: string option

The replay token that can often be turned back into an FsCheck replay configuration.

Field type: string option

Shrunk

Full Usage: Shrunk

Field type: CheckCase<'Args, 'Actual, 'Expected> option

The final shrunk failing case, when shrinking found a smaller counterexample.

Field type: CheckCase<'Args, 'Actual, 'Expected> option

SourceLocation

Full Usage: SourceLocation

Field type: SourceLocation option

The most relevant source location that Testify could recover for the failing check.

Field type: SourceLocation option

Test

Full Usage: Test

Field type: string

The rendered failing test expression or shrunk property case.

Field type: string

Instance members

Instance member Description

this.TryGetReplayConfig

Full Usage: this.TryGetReplayConfig

Returns: Config option Some replay-enabled config when the failing result carried a replay token that Testify could parse; otherwise None.

Attempts to reconstruct an FsCheck replay configuration for the failing run from the stored replay token.

Returns: Config option

Some replay-enabled config when the failing result carried a replay token that Testify could parse; otherwise None.

Type something to start searching.