Structure

Unicode.Scalar.UTF16View

No overview available.

Declaration

@frozen struct UTF16View

Topics

Type Aliases

typealias Unicode.Scalar.UTF16View.Indices

A type that represents the indices that are valid for subscripting the collection, in ascending order.

typealias Unicode.Scalar.UTF16View.Element

A type representing the sequence’s elements.

typealias Unicode.Scalar.UTF16View.Index

A type that represents a position in the collection.

typealias Unicode.Scalar.UTF16View.Iterator

A type that provides the collection’s iteration interface and encapsulates its iteration state.

typealias Unicode.Scalar.UTF16View.SubSequence

A sequence that represents a contiguous subrange of the collection’s elements.

Instance Properties

var count: Int

The number of elements in the collection.

var endIndex: Int

The “past the end” position—that is, the position one greater than the last valid subscript argument.

var first: UTF16.CodeUnit?

The first element of the collection.

var indices: Range<Int>

The indices that are valid for subscripting the collection, in ascending order.

var isEmpty: Bool

A Boolean value indicating whether the collection is empty.

var last: UTF16.CodeUnit?

The last element of the collection.

var lazy: LazySequence<Unicode.Scalar.UTF16View>

A sequence containing the same elements as this sequence, but on which some operations, such as map and filter, are implemented lazily.

var startIndex: Int

The position of the first code unit.

var underestimatedCount: Int

A value less than or equal to the number of elements in the collection.

Instance Methods

func allSatisfy((UTF16.CodeUnit) -> Bool) -> Bool

Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.

func compactMap<ElementOfResult>((UTF16.CodeUnit) -> ElementOfResult?) -> [ElementOfResult]

Returns an array containing the non-nil results of calling the given transformation with each element of this sequence.

func contains(UTF16.CodeUnit) -> Bool

Returns a Boolean value indicating whether the sequence contains the given element.

func contains(where: (UTF16.CodeUnit) -> Bool) -> Bool

Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.

func difference<C>(from: C) -> CollectionDifference<UTF16.CodeUnit>

Returns the difference needed to produce this collection’s ordered elements from the given collection.

func difference<C>(from: C, by: (C.Element, UTF16.CodeUnit) -> Bool) -> CollectionDifference<UTF16.CodeUnit>

Returns the difference needed to produce this collection’s ordered elements from the given collection, using the given predicate as an equivalence test.

func distance(from: Int, to: Int) -> Int

Returns the distance between two indices.

func drop(while: (UTF16.CodeUnit) -> Bool) -> Slice<Unicode.Scalar.UTF16View>

Returns a subsequence by skipping elements while predicate returns true and returning the remaining elements.

func dropFirst(Int) -> Slice<Unicode.Scalar.UTF16View>

Returns a subsequence containing all but the given number of initial elements.

func dropLast(Int) -> Slice<Unicode.Scalar.UTF16View>

Returns a subsequence containing all but the specified number of final elements.

func elementsEqual<OtherSequence>(OtherSequence) -> Bool

Returns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.

func elementsEqual<OtherSequence>(OtherSequence, by: (UTF16.CodeUnit, OtherSequence.Element) -> Bool) -> Bool

Returns a Boolean value indicating whether this sequence and another sequence contain equivalent elements in the same order, using the given predicate as the equivalence test.

func enumerated() -> EnumeratedSequence<Unicode.Scalar.UTF16View>

Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero and x represents an element of the sequence.

func filter((UTF16.CodeUnit) -> Bool) -> [UTF16.CodeUnit]

Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.

func first(where: (UTF16.CodeUnit) -> Bool) -> UTF16.CodeUnit?

Returns the first element of the sequence that satisfies the given predicate.

func firstIndex(of: UTF16.CodeUnit) -> Int?

Returns the first index where the specified value appears in the collection.

func firstIndex(where: (UTF16.CodeUnit) -> Bool) -> Int?

Returns the first index in which an element of the collection satisfies the given predicate.

func flatMap<SegmentOfResult>((UTF16.CodeUnit) -> SegmentOfResult) -> [SegmentOfResult.Element]

Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.

func forEach((UTF16.CodeUnit) -> Void)

Calls the given closure on each element in the sequence in the same order as a for-in loop.

func formIndex(inout Int, offsetBy: Int)

Offsets the given index by the specified distance.

func formIndex(inout Int, offsetBy: Int, limitedBy: Int) -> Bool

Offsets the given index by the specified distance, or so that it equals the given limiting index.

func formIndex(after: inout Int)

Replaces the given index with its successor.

func formIndex(before: inout Int)

Replaces the given index with its predecessor.

func index(Int, offsetBy: Int) -> Int

Returns an index that is the specified distance from the given index.

func index(Int, offsetBy: Int, limitedBy: Int) -> Int?

Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.

func index(after: Int) -> Int

Returns the position immediately after the given index.

func index(before: Int) -> Int

Returns the position immediately after the given index.

func index(of: UTF16.CodeUnit) -> Int?

Returns the first index where the specified value appears in the collection.

Deprecated
func index(where: (UTF16.CodeUnit) -> Bool) -> Int?

Returns the first index in which an element of the collection satisfies the given predicate.

Deprecated
func last(where: (UTF16.CodeUnit) -> Bool) -> UTF16.CodeUnit?

Returns the last element of the sequence that satisfies the given predicate.

func lastIndex(of: UTF16.CodeUnit) -> Int?

Returns the last index where the specified value appears in the collection.

func lastIndex(where: (UTF16.CodeUnit) -> Bool) -> Int?

Returns the index of the last element in the collection that matches the given predicate.

func lexicographicallyPrecedes<OtherSequence>(OtherSequence) -> Bool

Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the less-than operator (<) to compare elements.

func lexicographicallyPrecedes<OtherSequence>(OtherSequence, by: (UTF16.CodeUnit, UTF16.CodeUnit) -> Bool) -> Bool

Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.

func makeIterator() -> IndexingIterator<Unicode.Scalar.UTF16View>

Returns an iterator over the elements of the collection.

func map<T>((UTF16.CodeUnit) -> T) -> [T]

Returns an array containing the results of mapping the given closure over the sequence’s elements.

func max() -> UTF16.CodeUnit?

Returns the maximum element in the sequence.

func max(by: (UTF16.CodeUnit, UTF16.CodeUnit) -> Bool) -> UTF16.CodeUnit?

Returns the maximum element in the sequence, using the given predicate as the comparison between elements.

func min() -> UTF16.CodeUnit?

Returns the minimum element in the sequence.

func min(by: (UTF16.CodeUnit, UTF16.CodeUnit) -> Bool) -> UTF16.CodeUnit?

Returns the minimum element in the sequence, using the given predicate as the comparison between elements.

func prefix(Int) -> Slice<Unicode.Scalar.UTF16View>

Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.

func prefix(through: Int) -> Slice<Unicode.Scalar.UTF16View>

Returns a subsequence from the start of the collection through the specified position.

func prefix(upTo: Int) -> Slice<Unicode.Scalar.UTF16View>

Returns a subsequence from the start of the collection up to, but not including, the specified position.

func prefix(while: (UTF16.CodeUnit) -> Bool) -> Slice<Unicode.Scalar.UTF16View>

Returns a subsequence containing the initial elements until predicate returns false and skipping the remaining elements.

func randomElement() -> UTF16.CodeUnit?

Returns a random element of the collection.

func randomElement<T>(using: inout T) -> UTF16.CodeUnit?

Returns a random element of the collection, using the given generator as a source for randomness.

func reduce<Result>(Result, (Result, UTF16.CodeUnit) -> Result) -> Result

Returns the result of combining the elements of the sequence using the given closure.

func reduce<Result>(into: Result, (inout Result, UTF16.CodeUnit) -> ()) -> Result

Returns the result of combining the elements of the sequence using the given closure.

func reversed() -> ReversedCollection<Unicode.Scalar.UTF16View>

Returns a view presenting the elements of the collection in reverse order.

func shuffled() -> [UTF16.CodeUnit]

Returns the elements of the sequence, shuffled.

func shuffled<T>(using: inout T) -> [UTF16.CodeUnit]

Returns the elements of the sequence, shuffled using the given generator as a source for randomness.

func sorted() -> [UTF16.CodeUnit]

Returns the elements of the sequence, sorted.

func sorted(by: (UTF16.CodeUnit, UTF16.CodeUnit) -> Bool) -> [UTF16.CodeUnit]

Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.

func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (UTF16.CodeUnit) -> Bool) -> [Slice<Unicode.Scalar.UTF16View>]

Returns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.

func split(separator: UTF16.CodeUnit, maxSplits: Int, omittingEmptySubsequences: Bool) -> [Slice<Unicode.Scalar.UTF16View>]

Returns the longest possible subsequences of the collection, in order, around elements equal to the given element.

func starts<PossiblePrefix>(with: PossiblePrefix) -> Bool

Returns a Boolean value indicating whether the initial elements of the sequence are the same as the elements in another sequence.

func starts<PossiblePrefix>(with: PossiblePrefix, by: (UTF16.CodeUnit, PossiblePrefix.Element) -> Bool) -> Bool

Returns a Boolean value indicating whether the initial elements of the sequence are equivalent to the elements in another sequence, using the given predicate as the equivalence test.

func suffix(Int) -> Slice<Unicode.Scalar.UTF16View>

Returns a subsequence, up to the given maximum length, containing the final elements of the collection.

func suffix(from: Int) -> Slice<Unicode.Scalar.UTF16View>

Returns a subsequence from the specified position to the end of the collection.

func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<UTF16.CodeUnit>) -> R) -> R?

Call body(p), where p is a pointer to the collection’s contiguous storage. If no such storage exists, it is first created. If the collection does not support an internal representation in a form of contiguous storage, body is not called and nil is returned.

Subscripts

subscript(Range<Int>) -> Slice<Unicode.Scalar.UTF16View>

Accesses a contiguous subrange of the collection’s elements.

subscript(Int) -> UTF16.CodeUnit

Accesses the code unit at the specified position.

subscript<R>(R) -> Slice<Unicode.Scalar.UTF16View>

Accesses the contiguous subrange of the collection’s elements specified by a range expression.

Relationships

See Also

Printing and Displaying a Scalar

var description: String

A textual representation of the Unicode scalar.

func write<Target>(to: inout Target)

Writes the textual representation of the Unicode scalar into the given output stream.

func escaped(asASCII: Bool) -> String

Returns a string representation of the Unicode scalar.

var debugDescription: String

An escaped textual representation of the Unicode scalar, suitable for debugging.

var customMirror: Mirror

A mirror that reflects the Unicode.Scalar instance.

var customPlaygroundQuickLook: _PlaygroundQuickLook

A custom playground Quick Look for the Unicode.Scalar instance.

Deprecated