Header menu logo testify

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

Describes how a tested implementation should relate to a reference implementation for generated inputs.

Build reusable relations here, then execute them with Check.result, Check.should, Check.resultBy, or Check.shouldBy.

Record fields

Record Field Description

Because

Full Usage: Because

Field type: 'Args -> Observed<'Actual> -> Observed<'Expected> -> string option

Optionally explains why the relation failed for one case.

Field type: 'Args -> Observed<'Actual> -> Observed<'Expected> -> string option

Description

Full Usage: Description

Field type: string

A human-readable description of the relation.

Field type: string

Details

Full Usage: Details

Field type: 'Args -> Observed<'Actual> -> Observed<'Expected> -> FailureDetails option

Optionally provides structured nested details for rich failure rendering.

Field type: 'Args -> Observed<'Actual> -> Observed<'Expected> -> FailureDetails option

FormatActual

Full Usage: FormatActual

Field type: 'Args -> Observed<'Actual> -> string

Formats the tested-side observation for display in reports.

Field type: 'Args -> Observed<'Actual> -> string

FormatExpected

Full Usage: FormatExpected

Field type: 'Args -> Observed<'Expected> -> string

Formats the reference-side observation for display in reports.

Field type: 'Args -> Observed<'Expected> -> string

Label

Full Usage: Label

Field type: string

A short stable label used in reports and structured failure details.

Field type: string

Verify

Full Usage: Verify

Field type: 'Args -> Observed<'Actual> -> Observed<'Expected> -> bool

Determines whether the tested and reference observations satisfy the relation.

Field type: 'Args -> Observed<'Actual> -> Observed<'Expected> -> bool

Static members

Static member Description

CheckExpectation.AndAlso(a, b)

Full Usage: CheckExpectation.AndAlso(a, b)

Parameters:
Returns: CheckExpectation<'Args, 'Actual, 'Expected>
a : CheckExpectation<'Args, 'Actual, 'Expected>
b : CheckExpectation<'Args, 'Actual, 'Expected>
Returns: CheckExpectation<'Args, 'Actual, 'Expected>

CheckExpectation.OrElse(a, b)

Full Usage: CheckExpectation.OrElse(a, b)

Parameters:
Returns: CheckExpectation<'Args, 'Actual, 'Expected>
a : CheckExpectation<'Args, 'Actual, 'Expected>
b : CheckExpectation<'Args, 'Actual, 'Expected>
Returns: CheckExpectation<'Args, 'Actual, 'Expected>

Type something to start searching.