Contents

require(_:_:sourceLocation:)

Unwrap an optional value or, if it is nil, fail and throw an error.

Declaration

@freestanding(expression) macro require<T>(_ optionalValue: T?, _ comment: @autoclosure () -> Comment? = nil, sourceLocation: SourceLocation = #_sourceLocation) -> T

Parameters

  • optionalValue:

    The optional value to be unwrapped.

  • comment:

    A comment describing the expectation.

  • sourceLocation:

    The source location to which recorded expectations and issues should be attributed.

Mentioned in

Return Value

The unwrapped value of optionalValue.

Overview

If optionalValue is nil, an Issue is recorded for the test that is running in the current task and an instance of ExpectationFailedError is thrown.

See Also

Checking expectations