Structure

String.UnicodeScalarView

A view of a string’s contents as a collection of Unicode scalar values.

Overview

You can access a string’s view of Unicode scalar values by using its unicodeScalars property. Unicode scalar values are the 21-bit codes that are the basic unit of Unicode. Each scalar value is represented by a Unicode.Scalar instance and is equivalent to a UTF-32 code unit.

let flowers = "Flowers 💐"
for v in flowers.unicodeScalars {
    print(v.value)
}
// 70
// 108
// 111
// 119
// 101
// 114
// 115
// 32
// 128144

Some characters that are visible in a string are made up of more than one Unicode scalar value. In that case, a string’s unicodeScalars view contains more elements than the string itself.

let flag = "🇵🇷"
for c in flag {
    print(c)
}
// 🇵🇷

for v in flag.unicodeScalars {
    print(v.value)
}
// 127477
// 127479

You can convert a String.UnicodeScalarView instance back into a string using the String type’s init(_:) initializer.

let favemoji = "My favorite emoji is 🎉"
if let i = favemoji.unicodeScalars.index(where: { $0.value >= 128 }) {
    let asciiPrefix = String(favemoji.unicodeScalars[..<i])
    print(asciiPrefix)
}
// Prints "My favorite emoji is "

Topics

Initializers

init()

Creates an empty view instance.

init<S>(S)

Creates a new instance of a collection containing the elements of a sequence.

Beta
init(repeating: Unicode.Scalar, count: Int)

Creates a new collection containing the specified number of a single, repeated value.

Beta

Instance Properties

var count: Int

The number of elements in the collection.

var customMirror: Mirror

Returns a mirror that reflects the Unicode scalars view of a string.

var endIndex: String.UnicodeScalarView.Index

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

var first: Unicode.Scalar?

The first element of the collection.

Beta
var indices: DefaultBidirectionalIndices<String.UnicodeScalarView>

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: Unicode.Scalar?

The last element of the collection.

Beta
var lazy: LazyCollection<String.UnicodeScalarView>

A view onto this collection that provides lazy implementations of normally eager operations, such as map and filter.

var lazy: LazySequence<String.UnicodeScalarView>

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

var lazy: LazyBidirectionalCollection<String.UnicodeScalarView>

A view onto this collection that provides lazy implementations of normally eager operations, such as map and filter.

var startIndex: String.UnicodeScalarView.Index

The position of the first Unicode scalar value if the string is nonempty.

var underestimatedCount: Int

Returns a value less than or equal to the number of elements in the sequence, nondestructively.

Beta
var underestimatedCount: Int

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

Beta

Instance Methods

func append(Unicode.Scalar)

Adds an element to the end of the collection.

Beta
func append(Unicode.Scalar)

Appends the given Unicode scalar to the view.

Beta
func append<S>(contentsOf: S)

Appends the Unicode scalar values in the given sequence to the view.

func contains(Unicode.Scalar)

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

Beta
func contains(where: (Unicode.Scalar) -> Bool)

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

Beta
func drop(while: (Unicode.Scalar) -> Bool)

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

Beta
func dropFirst()

Returns a subsequence containing all but the first element of the sequence.

func dropFirst(Int)

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

func dropLast()

Returns a subsequence containing all but the last element of the sequence.

func dropLast(Int)

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

func elementsEqual<OtherSequence>(OtherSequence)

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

func elementsEqual<OtherSequence>(OtherSequence, by: (Unicode.Scalar, Unicode.Scalar) -> Bool)

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

Beta
func enumerated()

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((Unicode.Scalar) -> Bool)

Returns a new collection of the same type containing, in order, the elements of the original collection that satisfy the given predicate.

Beta
func first(where: (Unicode.Scalar) -> Bool)

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

Beta
func forEach((Unicode.Scalar) -> Void)

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

Beta
func index(after: String.UnicodeScalarView.Index)

Returns the next consecutive location after i.

func index(before: String.UnicodeScalarView.Index)

Returns the previous consecutive location before i.

func index(of: Unicode.Scalar)

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

Beta
func index(where: (Unicode.Scalar) -> Bool)

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

Beta
func insert(Unicode.Scalar, at: String.Index)

Inserts a new element into the collection at the specified position.

Beta
func insert<C>(contentsOf: C, at: String.Index)

Inserts the elements of a sequence into the collection at the specified position.

Beta
func lexicographicallyPrecedes<OtherSequence>(OtherSequence)

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: (Unicode.Scalar, Unicode.Scalar) -> Bool)

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

Beta
func makeIterator()

Returns an iterator over the Unicode scalars that make up this view.

func map<T>((Unicode.Scalar) -> T)

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

Beta
func map<T>((Unicode.Scalar) -> T)

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

Beta
func max()

Returns the maximum element in the sequence.

func max(by: (Unicode.Scalar, Unicode.Scalar) -> Bool)

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

Beta
func min()

Returns the minimum element in the sequence.

func min(by: (Unicode.Scalar, Unicode.Scalar) -> Bool)

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

Beta
func popFirst()

Removes and returns the first element of the collection.

func popLast()

Removes and returns the last element of the collection.

func prefix(Int)

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

func prefix(through: String.Index)

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

func prefix(upTo: String.Index)

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

func prefix(while: (Unicode.Scalar) -> Bool)

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

Beta
func reduce<Result>(Result, (Result, Unicode.Scalar) -> Result)

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

Beta
func remove(at: String.Index)

Removes and returns the element at the specified position.

Beta
func removeAll(keepingCapacity: Bool)

Removes all elements from the collection.

Beta
func removeFirst()

Removes and returns the first element of the collection.

Beta
func removeFirst()

Removes and returns the first element of the collection.

Beta
func removeFirst()

Removes and returns the first element of the collection.

Beta
func removeFirst(Int)

Removes the specified number of elements from the beginning of the collection.

func removeFirst(Int)

Removes the specified number of elements from the beginning of the collection.

Beta
func removeFirst(Int)

Removes the specified number of elements from the beginning of the collection.

Beta
func removeLast()

Removes and returns the last element of the collection.

Beta
func removeLast()

Removes and returns the last element of the collection.

Beta
func removeLast()

Removes and returns the last element of the collection.

Beta
func removeLast(Int)

Removes the given number of elements from the end of the collection.

func removeLast(Int)

Removes the specified number of elements from the end of the collection.

Beta
func removeLast(Int)

Removes the specified number of elements from the end of the collection.

Beta
func removeSubrange(Range<String.Index>)

Removes the elements in the specified subrange from the collection.

Beta
func removeSubrange<R>(R)

Removes the elements in the specified subrange from the collection.

Beta
func replaceSubrange<C>(Range<String.UnicodeScalarView.Index>, with: C)

Replaces the elements within the specified bounds with the given Unicode scalar values.

func replaceSubrange<C, R>(R, with: C)

Replaces the specified subrange of elements with the given collection.

Beta
func reserveCapacity(Int)

Prepares the collection to store the specified number of elements, when doing so is appropriate for the underlying type.

func reserveCapacity(Int)

Reserves enough space in the view’s underlying storage to store the specified number of ASCII characters.

Beta
func reversed()

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

func sorted()

Returns the elements of the sequence, sorted.

func sorted(by: (Unicode.Scalar, Unicode.Scalar) -> Bool)

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

Beta
func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (Unicode.Scalar) -> Bool)

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

Beta
func split(separator: Unicode.Scalar, maxSplits: Int, omittingEmptySubsequences: Bool)

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

Beta
func starts<PossiblePrefix>(with: PossiblePrefix)

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: (Unicode.Scalar, Unicode.Scalar) -> 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.

Beta
func suffix(Int)

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

func suffix(from: String.Index)

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

Subscripts

subscript(String.UnicodeScalarView.Index)

Accesses the Unicode scalar value at the given position.

subscript(Range<String.UnicodeScalarView.Index>)

Accesses the Unicode scalar values in the given range.

Structures

struct String.UnicodeScalarView.Iterator

An iterator over the Unicode scalars that make up a UnicodeScalarView collection.

See Also

Related String Types

struct Substring

A slice of a string.

Beta
protocol StringProtocol

A type that can represent a string as a collection of characters.

Beta
struct String.CharacterView

A view of a string’s contents as a collection of characters.

struct String.UTF16View

A view of a string’s contents as a collection of UTF-16 code units.

struct String.UTF8View

A view of a string’s contents as a collection of UTF-8 code units.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software