文書 > Swift > String > Substring > formIndex(_:offsetBy:limitedBy:)

インスタンスメソッド

formIndex(_:offsetBy:limitedBy:)

与えられたインデックスを指定された距離だけオフセットするか、または与えられた制限インデックスと等しくなるようにします。

func formIndex(_ i: inout String.Index, offsetBy distance: Int, limitedBy limit: String.Index) -> Bool

i	コレクションの有効なインデックス。
distance	オフセット i までの距離 (distance)。コレクションが BidirectionalCollection プロトコルに準拠していない限り、distance は負にしてはいけません。
limit	制限 (limit) として使用すべきコレクションの有効なインデックス。distance > 0 の場合、i より小さい制限は効果がありません。同様に、distance < 0 の場合、i より大きい制限は効果がありません。

制限を超えずに正確に distance ステップで i がオフセットされている場合は true。そうでなければ、false。戻り値が false の場合、i の値は limit に等しくなります。

limit として渡されたインデックスがこれらの境界を超えたオフセットを妨げない限り、distance として渡された値はコレクションの境界を超えて i をオフセットしてはいけません。

複雑さ：コレクションが RandomAccessCollection に準拠している場合は O(1)。それ以外の場合、O(k)、ここで k は distance の絶対値です。