Structure

String.CharacterView

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

Overview

In Swift, every string provides a view of its contents as characters. In this view, many individual characters—for example, “é”, “김”, and “🇮🇳”—can be made up of multiple Unicode code points. These code points are combined by Unicode’s boundary algorithms into extended grapheme clusters, represented by the Character type. Each element of a CharacterView collection is a Character instance.

let flowers = "Flowers 💐"
for c in flowers.characters {
    print(c)
}
// F
// l
// o
// w
// e
// r
// s
//
// 💐

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

let name = "Marie Curie"
if let firstSpace = name.characters.index(of: " ") {
    let firstName = String(name.characters[..<firstSpace])
    print(firstName)
}
// Prints "Marie"

Topics

Initializers

init()

Creates an empty character view.

init<S>(S)

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

init(String)

Creates a view of the given string.

init(repeating: Character, 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.

Beta
var endIndex: String.CharacterView.Index

A character view’s “past the end” position—that is, the position one greater than the last valid subscript argument.

var first: Character?

The first element of the collection.

Beta
var indices: DefaultBidirectionalIndices<String.CharacterView>

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

Beta
var isEmpty: Bool

A Boolean value indicating whether the collection is empty.

Beta
var last: Character?

The last element of the collection.

Beta
var lazy: LazyBidirectionalCollection<String.CharacterView>

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

Beta
var lazy: LazyCollection<String.CharacterView>

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

Beta
var lazy: LazySequence<String.CharacterView>

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

Beta
var startIndex: String.CharacterView.Index

The position of the first character in a nonempty character view.

var underestimatedCount: Int

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

Beta
var underestimatedCount: Int

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

Beta

Instance Methods

func append(Character)

Adds an element to the end of the collection.

func append(Character)

Appends the given character to the character view.

Beta
func append<S>(contentsOf: S)

Adds the elements of a sequence or collection to the end of this collection.

func contains(Character)

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

Beta
func contains(where: (Character) -> Bool)

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

Beta
func drop(while: (Character) -> 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.

Beta
func dropFirst(Int)

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

Beta
func dropLast()

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

Beta
func dropLast(Int)

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

Beta
func elementsEqual<OtherSequence>(OtherSequence)

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

Beta
func elementsEqual<OtherSequence>(OtherSequence, by: (Character, Character) -> 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.

Beta
func filter((Character) -> 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: (Character) -> Bool)

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

Beta
func forEach((Character) -> 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.CharacterView.Index)

Returns the next consecutive position after i.

func index(before: String.CharacterView.Index)

Returns the previous consecutive position before i.

func index(of: Character)

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

Beta
func index(where: (Character) -> Bool)

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

Beta
func insert(Character, at: String.CharacterView.Index)

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

Beta
func insert<C>(contentsOf: C, at: String.CharacterView.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.

Beta
func lexicographicallyPrecedes<OtherSequence>(OtherSequence, by: (Character, Character) -> 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 elements of the collection.

Beta
func map<T>((Character) -> T)

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

Beta
func map<T>((Character) -> 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.

Beta
func max(by: (Character, Character) -> 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.

Beta
func min(by: (Character, Character) -> 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.

Beta
func popLast()

Removes and returns the last element of the collection.

Beta
func prefix(Int)

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

Beta
func prefix(through: String.CharacterView.Index)

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

Beta
func prefix(upTo: String.CharacterView.Index)

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

Beta
func prefix(while: (Character) -> Bool)

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

Beta
func reduce<Result>(Result, (Result, Character) -> Result)

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

Beta
func remove(at: String.CharacterView.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.

Beta
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 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 removeLast(Int)

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

Beta
func removeSubrange(Range<String.CharacterView.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.CharacterView.Index>, with: C)

Replaces the characters within the specified bounds with the given characters.

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

Replaces the specified subrange of elements with the given collection.

Beta
func reserveCapacity(Int)

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

func reserveCapacity(Int)

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

Beta
func reversed()

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

Beta
func sorted()

Returns the elements of the sequence, sorted.

Beta
func sorted(by: (Character, Character) -> 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: (Character) -> Bool)

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

Beta
func split(separator: Character, 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.

Beta
func starts<PossiblePrefix>(with: PossiblePrefix, by: (Character, Character) -> 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.

Beta
func suffix(from: String.CharacterView.Index)

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

Beta

Subscripts

subscript(String.CharacterView.Index)

Accesses the character at the given position.

subscript(Range<String.CharacterView.Index>)

Accesses the characters in the given range.

Structures

struct String.CharacterView.Index

A position in a string’s CharacterView instance.

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.UnicodeScalarView

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

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