struct String.UTF16View A collection of UTF-16 code units that encodes a String value. Inheritance CollectionType, CustomDebugStringConvertible, CustomStringConvertible, Indexable, SequenceType, _Reflectable View Protocol Hierarchy → Associated Types Generator = IndexingGenerator<String.UTF16View> Type alias inferred. Element = CodeUnit Type alias inferred. Index = String.UTF16View.Index Type alias inferred. SubSequence = String.UTF16View Type alias inferred. Nested Types String.UTF16View.Index Import import Swift Instance Variables var count: String.UTF16View.Index.Distance Returns the number of elements. Complexity: O(1) if Index conforms to RandomAccessIndexType; O(N) otherwise. Declaration var count: String.UTF16View.Index.Distance { get } Declared In CollectionType var debugDescription: String Declaration var debugDescription: String { get } var description: String Declaration var description: String { get } var endIndex: String.UTF16View.Index The "past the end" position. endIndex is not a valid argument to subscript, and is always reachable from startIndex by zero or more applications of successor(). Declaration var endIndex: String.UTF16View.Index { get } var first: CodeUnit? Returns the first element of self, or nil if self is empty. Complexity: O(1) Declaration var first: CodeUnit? { get } Declared In CollectionType var indices: Range<String.UTF16View.Index> Returns the range of valid index values. The result's endIndex is the same as that of self. Because Range is half-open, iterating the values of the result produces all valid subscript arguments for self, omitting its endIndex. Declaration var indices: Range<String.UTF16View.Index> { get } Declared In CollectionType var isEmpty: Bool Returns true iff self is empty. Complexity: O(1) Declaration var isEmpty: Bool { get } Declared In CollectionType var last: CodeUnit? Declaration var last: CodeUnit? { get } Declared In CollectionType var lazy: LazyCollection<String.UTF16View> A collection with contents identical to self, but on which normally-eager operations such as map and filter are implemented lazily. See Also: LazySequenceType, LazyCollectionType. Declaration var lazy: LazyCollection<String.UTF16View> { get } Declared In CollectionType var startIndex: String.UTF16View.Index The position of the first code unit if the String is non-empty; identical to endIndex otherwise. Declaration var startIndex: String.UTF16View.Index { get } Subscripts subscript(_: Range<String.UTF16View.Index>) Access the elements delimited by the given half-open range of indices. Complexity: O(1) unless bridging from Objective-C requires an O(N) conversion. Declaration subscript(subRange: Range<String.UTF16View.Index>) -> String.UTF16View { get } subscript(_: String.UTF16View.Index) Access the element at position. Requires: position is a valid position in self and position != endIndex. Declaration subscript(i: String.UTF16View.Index) -> CodeUnit { get } Instance Methods func contains(_:) Returns true iff an element in self satisfies predicate. Declaration func contains(@noescape predicate: (CodeUnit) throws -> Bool) rethrows -> Bool Declared In CollectionType, SequenceType func dropFirst() Returns a subsequence containing all but the first element. Complexity: O(1) Declaration func dropFirst() -> String.UTF16View Declared In CollectionType, SequenceType func dropFirst(_:) Returns a subsequence containing all but the first n elements. Requires: n >= 0 Complexity: O(n) Declaration func dropFirst(n: Int) -> String.UTF16View Declared In CollectionType, SequenceType func dropLast() Returns a subsequence containing all but the last element. Requires: self is a finite sequence. Complexity: O(self.count) Declaration func dropLast() -> String.UTF16View Declared In CollectionType, SequenceType func dropLast(_:) Returns a subsequence containing all but the last n elements. Requires: n >= 0 Complexity: O(self.count) Declaration func dropLast(n: Int) -> String.UTF16View Declared In CollectionType, SequenceType func elementsEqual(_:isEquivalent:) Returns true iff self and other contain equivalent elements, using isEquivalent as the equivalence test. Requires: isEquivalent is an equivalence relation. Declaration func elementsEqual<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence, @noescape isEquivalent: (CodeUnit, CodeUnit) throws -> Bool) rethrows -> Bool Declared In CollectionType, SequenceType func enumerate() Returns a lazy SequenceType containing pairs (n, x), where ns are consecutive Ints starting at zero, and xs are the elements of base: > for (n, c) in "Swift".characters.enumerate() { print("\(n): '\(c)'") } 0: 'S' 1: 'w' 2: 'i' 3: 'f' 4: 't' Declaration func enumerate() -> EnumerateSequence<String.UTF16View> Declared In CollectionType, SequenceType func filter(_:) Returns an Array containing the elements of self, in order, that satisfy the predicate includeElement. Declaration func filter(@noescape includeElement: (CodeUnit) throws -> Bool) rethrows -> [CodeUnit] Declared In CollectionType, SequenceType func flatMap<T>(_: (CodeUnit) throws -> T?) Returns an Array containing the non-nil results of mapping transform over self. Complexity: O(M + N), where M is the length of self and N is the length of the result. Declaration func flatMap<T>(@noescape transform: (CodeUnit) throws -> T?) rethrows -> [T] Declared In CollectionType, SequenceType func flatMap<S : SequenceType>(_: (CodeUnit) throws -> S) Returns an Array containing the concatenated results of mapping transform over self. s.flatMap(transform) is equivalent to Array(s.map(transform).flatten()) Complexity: O(M + N), where M is the length of self and N is the length of the result. Declaration func flatMap<S : SequenceType>(transform: (CodeUnit) throws -> S) rethrows -> [S.Generator.Element] Declared In CollectionType, SequenceType func forEach(_:) Call body on each element in self in the same order as a for-in loop. sequence.forEach { // body code } is similar to: for element in sequence { // body code } Note: You cannot use the break or continue statement to exit the current call of the body closure or skip subsequent calls. Note: Using the return statement in the body closure will only exit from the current call to body, not any outer scope, and won't skip subsequent calls. Complexity: O(self.count) Declaration func forEach(@noescape body: (CodeUnit) throws -> Void) rethrows Declared In CollectionType, SequenceType func generate() Declaration func generate() -> IndexingGenerator<String.UTF16View> Declared In CollectionType func indexOf(_:) Returns the first index where predicate returns true for the corresponding value, or nil if such value is not found. Complexity: O(self.count). Declaration func indexOf(@noescape predicate: (CodeUnit) throws -> Bool) rethrows -> String.UTF16View.Index? Declared In CollectionType func lexicographicalCompare(_:isOrderedBefore:) Returns true iff self precedes other in a lexicographical ("dictionary") ordering, using isOrderedBefore as the comparison between elements. Note: This method implements the mathematical notion of lexicographical ordering, which has no connection to Unicode. If you are sorting strings to present to the end-user, you should use String APIs that perform localized comparison. Requires: isOrderedBefore is a strict weak ordering over the elements of self and other. Declaration func lexicographicalCompare<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence, @noescape isOrderedBefore: (CodeUnit, CodeUnit) throws -> Bool) rethrows -> Bool Declared In CollectionType, SequenceType func map(_:) Returns an Array containing the results of mapping transform over self. Complexity: O(N). Declaration func map<T>(@noescape transform: (CodeUnit) throws -> T) rethrows -> [T] Declared In CollectionType, SequenceType func maxElement(_:) Returns the maximum element in self or nil if the sequence is empty. Complexity: O(elements.count). Requires: isOrderedBefore is a strict weak ordering over self. Declaration func maxElement(@noescape isOrderedBefore: (CodeUnit, CodeUnit) throws -> Bool) rethrows -> CodeUnit? Declared In CollectionType, SequenceType func minElement(_:) Returns the minimum element in self or nil if the sequence is empty. Complexity: O(elements.count). Requires: isOrderedBefore is a strict weak ordering over self. Declaration func minElement(@noescape isOrderedBefore: (CodeUnit, CodeUnit) throws -> Bool) rethrows -> CodeUnit? Declared In CollectionType, SequenceType mutating func popFirst() If !self.isEmpty, remove the first element and return it, otherwise return nil. Complexity: O(1) Declaration mutating func popFirst() -> CodeUnit? Declared In CollectionType mutating func popLast() If !self.isEmpty, remove the last element and return it, otherwise return nil. Complexity: O(self.count) Deprecated: it will be removed in Swift 3. Declaration mutating func popLast() -> CodeUnit? Declared In CollectionType func prefix(_:) Returns a subsequence, up to maxLength in length, containing the initial elements. If maxLength exceeds self.count, the result contains all the elements of self. Requires: maxLength >= 0 Complexity: O(maxLength) Declaration func prefix(maxLength: Int) -> String.UTF16View Declared In CollectionType, SequenceType func prefixThrough(_:) Returns prefixUpTo(position.successor()) Complexity: O(1) Declaration func prefixThrough(position: String.UTF16View.Index) -> String.UTF16View Declared In CollectionType func prefixUpTo(_:) Returns self[startIndex..<end] Complexity: O(1) Declaration func prefixUpTo(end: String.UTF16View.Index) -> String.UTF16View Declared In CollectionType func reduce(_:combine:) Returns the result of repeatedly calling combine with an accumulated value initialized to initial and each element of self, in turn, i.e. return combine(combine(...combine(combine(initial, self[0]), self[1]),...self[count-2]), self[count-1]). Declaration func reduce<T>(initial: T, @noescape combine: (T, CodeUnit) throws -> T) rethrows -> T Declared In CollectionType, SequenceType mutating func removeFirst() Remove the element at startIndex and return it. Complexity: O(1) Requires: !self.isEmpty. Declaration mutating func removeFirst() -> CodeUnit Declared In CollectionType mutating func removeFirst(_:) Remove the first n elements. Complexity: - O(1) if Index conforms to RandomAccessIndexType - O(n) otherwise Requires: n >= 0 && self.count >= n. Declaration mutating func removeFirst(n: Int) Declared In CollectionType mutating func removeLast() Remove an element from the end. Complexity: O(1) Requires: !self.isEmpty Declaration mutating func removeLast() -> CodeUnit Declared In CollectionType mutating func removeLast(_:) Remove the last n elements. Complexity: - O(1) if Index conforms to RandomAccessIndexType - O(n) otherwise Requires: n >= 0 && self.count >= n. Declaration mutating func removeLast(n: Int) Declared In CollectionType func reverse() Returns an Array containing the elements of self in reverse order. Complexity: O(N), where N is the length of self. Declaration func reverse() -> [CodeUnit] Declared In CollectionType, SequenceType func sort(_:) Returns an Array containing the sorted elements of source according to isOrderedBefore. The sorting algorithm is not stable (can change the relative order of elements for which isOrderedBefore does not establish an order). Requires: isOrderedBefore is a strict weak ordering over the elements in self. Declaration func sort(@noescape isOrderedBefore: (CodeUnit, CodeUnit) -> Bool) -> [CodeUnit] Declared In CollectionType, SequenceType func split(_:allowEmptySlices:isSeparator:) Returns the maximal SubSequences of self, in order, that don't contain elements satisfying the predicate isSeparator. maxSplit: The maximum number of SubSequences to return, minus 1. If maxSplit + 1 SubSequences are returned, the last one is a suffix of self containing the remaining elements. The default value is Int.max. allowEmptySubsequences: If true, an empty SubSequence is produced in the result for each pair of consecutive elements satisfying isSeparator. The default value is false. Requires: maxSplit >= 0 Declaration func split(maxSplit: Int = default, allowEmptySlices: Bool = default, @noescape isSeparator: (CodeUnit) throws -> Bool) rethrows -> [String.UTF16View] Declared In CollectionType, SequenceType func startsWith(_:isEquivalent:) Returns true iff self begins with elements equivalent to those of other, using isEquivalent as the equivalence test. Returns true if other is empty. Requires: isEquivalent is an equivalence relation. Declaration func startsWith<OtherSequence : SequenceType where OtherSequence.Generator.Element == Generator.Element>(other: OtherSequence, @noescape isEquivalent: (CodeUnit, CodeUnit) throws -> Bool) rethrows -> Bool Declared In CollectionType, SequenceType func suffix(_:) Returns a slice, up to maxLength in length, containing the final elements of s. If maxLength exceeds s.count, the result contains all the elements of s. Requires: maxLength >= 0 Complexity: O(self.count) Declaration func suffix(maxLength: Int) -> String.UTF16View Declared In CollectionType, SequenceType func suffixFrom(_:) Returns self[start..<endIndex] Complexity: O(1) Declaration func suffixFrom(start: String.UTF16View.Index) -> String.UTF16View Declared In CollectionType func underestimateCount() Returns a value less than or equal to the number of elements in self, nondestructively. Complexity: O(N). Declaration func underestimateCount() -> Int Declared In CollectionType, SequenceType