struct String.UnicodeScalarView.Index A position in a String.UnicodeScalarView. Inheritance BidirectionalIndexType, Comparable, Equatable, 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 String(unicodeScalars).indices. Declaration init(_ characterIndex: 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 String(unicodeScalars).utf8.indices. 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 String(unicodeScalars).utf16.indices. Declaration init?(_ utf16Index: UTF16Index, within unicodeScalars: String.UnicodeScalarView) Instance Methods func advancedBy(_:) Return the result of advancing self by n positions. Returns: - If n > 0, the result of applying successor to self n times. - If n < 0, the result of applying predecessor to self -n times. - Otherwise, self. Requires: n >= 0 if only conforming to ForwardIndexType Complexity: - O(1) if conforming to RandomAccessIndexType - O(abs(n)) otherwise Declaration func advancedBy(n: String.UnicodeScalarView.Index.Distance) -> String.UnicodeScalarView.Index Declared In BidirectionalIndexType, ForwardIndexType func advancedBy(_:limit:) Return the result of advancing self by n positions, or until it equals limit. Returns: - If n > 0, the result of applying successor to self n times but not past limit. - If n < 0, the result of applying predecessor to self -n times but not past limit. - Otherwise, self. Requires: n >= 0 if only conforming to ForwardIndexType. Complexity: - O(1) if conforming to RandomAccessIndexType - O(abs(n)) otherwise Declaration func advancedBy(n: String.UnicodeScalarView.Index.Distance, limit: String.UnicodeScalarView.Index) -> String.UnicodeScalarView.Index Declared In BidirectionalIndexType, ForwardIndexType func distanceTo(_:) Measure the distance between self and end. Requires: - start and end are part of the same sequence when conforming to RandomAccessSequenceType. - end is reachable from self by incrementation otherwise. Complexity: - O(1) if conforming to RandomAccessIndexType - O(n) otherwise, where n is the function's result. Declaration func distanceTo(end: String.UnicodeScalarView.Index) -> String.UnicodeScalarView.Index.Distance Declared In BidirectionalIndexType, ForwardIndexType 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 characters.unicodeScalars.indices. Declaration func samePositionIn(characters: String) -> Index? func samePositionIn(_: String.UTF8View) Return the position in utf8 that corresponds exactly to self. Requires: self is an element of String(utf8)!.indices. 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 String(utf16)!.indices. 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