String.UnicodeScalarView.Index

struct String.UnicodeScalarView.Index

A position in a String.UnicodeScalarView

Inheritance BidirectionalIndexType, Comparable, Equatable, ForwardIndexType, _BidirectionalIndexType, _Comparable, _ForwardIndexType, _Incrementable View Protocol Hierarchy →
Import import Swift

Initializers

init(_:within:)

Construct the position in unicodeScalars that corresponds exactly to characterIndex.

Requires: characterIndex is an element of indices(String(unicodeScalars)).

Declaration

init(_ characterIndex: String.Index, within unicodeScalars: String.UnicodeScalarView)
init?(_: UTF8Index, within: String.UnicodeScalarView)

Construct the position in unicodeScalars that corresponds exactly to utf8Index. If no such position exists, the result is nil.

Requires: utf8Index is an element of indices(String(unicodeScalars).utf8).

Declaration

init?(_ utf8Index: UTF8Index, within unicodeScalars: String.UnicodeScalarView)
init?(_: UTF16Index, within: String.UnicodeScalarView)

Construct the position in unicodeScalars that corresponds exactly to utf16Index. If no such position exists, the result is nil.

Requires: utf16Index is an element of indices(String(unicodeScalars).utf16).

Declaration

init?(_ utf16Index: UTF16Index, within unicodeScalars: String.UnicodeScalarView)

Instance Methods

func predecessor()

Returns the previous consecutive value before self.

Requires: the previous value is representable.

Declaration

func predecessor() -> String.UnicodeScalarView.Index
func samePositionIn(_: String)

Return the position in characters that corresponds exactly to self, or if no such position exists, nil.

Requires: self is an element of indices(characters.unicodeScalars).

Declaration

func samePositionIn(characters: String) -> String.Index?
func samePositionIn(_: String.UTF8View)

Return the position in utf8 that corresponds exactly to self.

Requires: self is an element of indices(String(utf8)!).

Declaration

func samePositionIn(utf8: String.UTF8View) -> String.UTF8View.Index
func samePositionIn(_: String.UTF16View)

Return the position in utf16 that corresponds exactly to self.

Requires: self is an element of indices(String(utf16)!).

Declaration

func samePositionIn(utf16: String.UTF16View) -> String.UTF16View.Index
func successor()

Returns the next consecutive value after self.

Requires: the next value is representable.

Declaration

func successor() -> String.UnicodeScalarView.Index