Instance Method

formIndex(_:offsetBy:)

Offsets the given index by the specified distance.

Declaration

Current

func formIndex(_ i: inout Index, offsetBy distance: Int)

Previous

func formIndex(_ i: inout String.Index, offsetBy distance: Int)

Parameters

i

A valid index of the collection.

distance

The distance to offset i. distance must not be negative unless the collection conforms to the BidirectionalCollection protocol.

Discussion

The value passed as distance must not offset i beyond the bounds of the collection.

Complexity: O(1) if the collection conforms to RandomAccessCollection; otherwise, O(k), where k is the absolute value of distance.

See Also

Manipulating Indices

var startIndex: String.Index

The position of the first character in a nonempty string.

var endIndex: String.Index

A string’s “past the end” position—that is, the position one greater than the last valid subscript argument.

func index(after: String.Index) -> String.Index

Returns the position immediately after the given index.

func formIndex(after: inout Index)

Replaces the given index with its successor.

func index(before: String.Index) -> String.Index

Returns the position immediately before the given index.

func formIndex(before: inout Index)

Replaces the given index with its predecessor.

func index(String.Index, offsetBy: String.IndexDistance) -> String.Index

Returns an index that is the specified distance from the given index.

func index(String.Index, offsetBy: String.IndexDistance, limitedBy: String.Index) -> String.Index?

Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.

func formIndex(inout Index, offsetBy: Int, limitedBy: Index) -> Bool

Offsets the given index by the specified distance, or so that it equals the given limiting index.

var indices: DefaultIndices<String>

The indices that are valid for subscripting the collection, in ascending order.