String.UnicodeScalarView.Index

struct String.UnicodeScalarView.Index

A position in a String.UnicodeScalarView.

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

Instance Methods

func advancedBy(_:)

Returns 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:)

Returns 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 successor()

Returns the next consecutive value after self.

Requires: The next value is representable.

Declaration

func successor() -> String.UnicodeScalarView.Index