マクロ

require(throws:_:sourceLocation:
performing:)

式が常に与えられた型のエラーを throw することを確認し、そうでない場合はエラーを throw します。

iOS iPadOS Mac Catalyst macOS tvOS visionOS

watchOS Swift 6.0+ Xcode 16.0+

@discardableResult @freestanding(expression)
macro require<E, R>(
    throws errorType: E.Type,
    _ comment: @autoclosure () -> Comment? = nil,
    sourceLocation: SourceLocation = #_sourceLocation,
    performing expression: () async throws -> R
) -> E where E : Error

パラメータ

errorType

throw されると予想されるエラーの型。expression が全てのエラーを throw する可能性がある、または throw されたエラーの特定の型が重要でない場合は、(any Error).self を渡して下さい。

comment

期待を説明するコメント。

sourceLocation

記録された期待と問題の原因となるソースの場所。

expression

評価されるべき式。

戻り値

expression によって throw された errorType のインスタンス。

以下で言及

Swift コード内のエラーのテスト

概観

Throws が一致するエラーを throw しない場合、ExpectationFailedError のインスタンス。expression によって throw されたエラーは再び throw されません。

expression 式が与えられた型ののエラーを throw する必要がある場合は、#require() のこのオーバーロードを使用して下さい。

try #require(throws: EngineFailureError.self) {
  FoodTruck.shared.engine.batteryLevel = 0
  try FoodTruck.shared.engine.start()
}

expression がエラーを throw しない場合、または errorType のインスタンスではないエラーを throw した場合、現在のタスクで実行中のテストに対して Issue が記録され、ExpectationFailedError のインスタンスが throw されます。expression によって返される値はすべて破棄されます。