Function 関数

preconditionFailure(_:file:line:)

Indicates that a precondition was violated. これは前提条件が破られたことを指し示します。

Declaration 宣言

func preconditionFailure(_ message: @autoclosure () -> String = String(), file: StaticString = #file, line: UInt = #line) -> Never

Parameters パラメータ

message

A string to print in a playground or -Onone build. The default is an empty string. プレイグラウンドまたは-Ononeビルドにおいて出力される文字列。初期状態では空の文字列です。

file

The file name to print with message. The default is the file where preconditionFailure(_:file:line:) is called. messageとともに出力するファイル名。初期状態では、preconditionFailure(_:file:line:)が呼び出されたところのファイルです。

line

The line number to print along with message. The default is the line number where preconditionFailure(_:file:line:) is called. messageに加えて出力される行番号。初期状態では、preconditionFailure(_:file:line:)が呼び出されたところの行番号です。

Discussion 解説

Use this function to stop the program when control flow can only reach the call if your API was improperly used. This function’s effects vary depending on the build flag used: あなたのAPIが誤って使われた場合にその呼び出しに制御の流れが届く時にだけこの関数を使ってプログラムを停止してください。この関数の効果は使用されるビルドフラグに依存して多様に異なります:

  • In playgrounds and -Onone builds (the default for Xcode’s Debug configuration), stops program execution in a debuggable state after printing message. プレイグラウンドおよび-Ononeビルド(XcodeのDebug構成の初期設定)では、messageを出力した後デバッグ可能な状態でプログラム実行を停止します。

  • In -O builds (the default for Xcode’s Release configuration), stops program execution. -Oビルド(XcodeのRelease構成の初期設定)では、プログラム実行を停止します。

  • In -Ounchecked builds, the optimizer may assume that this function is never called. Failure to satisfy that assumption is a serious programming error. -Ouncheckedビルドでは、最適化はこの関数が決して呼ばれないと決めてかかります。了解事項を満たすことの失敗は、重大なプログラミングエラーです。

See Also 参照

Testing テスト