samePosition(in:)

Declaration

func samePosition(in utf16: String.UTF16View) -> String.UTF16View.Index?

Parameters

• utf16:

  The view to use for the index conversion. This index must be a valid index of at least one view of the string shared by utf16.

Return Value

The position in utf16 that corresponds exactly to this index. If this index does not have an exact corresponding position in utf16, this method returns nil. For example, an attempt to convert the position of a UTF-8 continuation byte returns nil.

Discussion

The index must be a valid index of String(utf16).

This example first finds the position of the character "é" and then uses this method find the same position in the string’s utf16 view.

let cafe = "Café"
if let i = cafe.firstIndex(of: "é") {
    let j = i.samePosition(in: cafe.utf16)!
    print(cafe.utf16[j])
}
// Prints "233"