No overview available.
SDK
- Xcode 9.0+
Framework
- Swift Standard Library
Declaration
@frozen struct UnicodeScalarView
StructureSubstring
Substring.UnicodeScalarView
Topics
Type Aliases
typealias Substring.UnicodeScalarView.Element A type representing the sequence’s elements.
typealias Substring.UnicodeScalarView.Index A type that represents a position in the collection.
typealias Substring.UnicodeScalarView.Indices A type that represents the indices that are valid for subscripting the collection, in ascending order.
typealias Substring.UnicodeScalarView.Iterator A type that provides the collection’s iteration interface and encapsulates its iteration state.
typealias Substring.UnicodeScalarView.SubSequence A sequence that represents a contiguous subrange of the collection’s elements.
Initializers
init()Creates a new, empty collection.
init<S>(S)Creates a new instance of a collection containing the elements of a sequence.
init(repeating: String.UnicodeScalarView.Element, count: Int)Creates a new collection containing the specified number of a single, repeated value.
Instance Properties
var count: IntThe number of elements in the collection.
var endIndex : Substring.UnicodeScalarView.Index The collection’s “past the end” position—that is, the position one greater than the last valid subscript argument.
var first: String.UnicodeScalarView.Element? The first element of the collection.
var indices: Substring.UnicodeScalarView.Indices The indices that are valid for subscripting the collection, in ascending order.
var isEmpty : BoolA Boolean value indicating whether the collection is empty.
var last: String.UnicodeScalarView.Element? The last element of the collection.
var lazy: LazySequence<Substring.UnicodeScalarView> A sequence containing the same elements as this sequence, but on which some operations, such as map and filter, are implemented lazily.
var startIndex : Substring.UnicodeScalarView.Index The position of the first element in a nonempty collection.
var underestimatedCount : IntA value less than or equal to the number of elements in the collection.
Instance Methods
func allSatisfy ((String.UnicodeScalarView.Element) -> Bool) -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func append(String.UnicodeScalarView.Element) Adds an element to the end of the collection.
func append<S>(contentsOf : S)Adds the elements of a sequence or collection to the end of this collection.
func applying(CollectionDifference<String.UnicodeScalarView.Element>) -> Substring.UnicodeScalarView? Applies the given difference to this collection.
func compactMap <ElementOfResult>((String.UnicodeScalarView.Element) -> ElementOfResult?) -> [ElementOfResult] Returns an array containing the non-nil results of calling the given transformation with each element of this sequence.
func contains(String.UnicodeScalarView.Element) -> Bool Returns a Boolean value indicating whether the sequence contains the given element.
func contains(where: (String.UnicodeScalarView.Element) -> Bool) -> Bool Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func difference<C>(from: C) -> CollectionDifference<String.UnicodeScalarView.Element> Returns the difference needed to produce this collection’s ordered elements from the given collection.
func difference<C>(from: C, by: (C.Element, String.UnicodeScalarView.Element) -> Bool) -> CollectionDifference<String.UnicodeScalarView.Element> 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: Substring.UnicodeScalarView.Index, to: Substring.UnicodeScalarView.Index) -> Int Returns the distance between two indices.
func drop(while: (String.UnicodeScalarView.Element) -> Bool) -> Substring.UnicodeScalarView Returns a subsequence by skipping elements while predicate returns true and returning the remaining elements.
func dropFirst (Int) -> Substring.UnicodeScalarView Returns a subsequence containing all but the given number of initial elements.
func dropLast (Int) -> Substring.UnicodeScalarView 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: (String.UnicodeScalarView.Element, 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<Substring.UnicodeScalarView> 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((String.UnicodeScalarView.Element) -> Bool) -> Substring.UnicodeScalarView Returns a new collection of the same type containing, in order, the elements of the original collection that satisfy the given predicate.
func first(where: (String.UnicodeScalarView.Element) -> Bool) -> String.UnicodeScalarView.Element? Returns the first element of the sequence that satisfies the given predicate.
func firstIndex (of: String.UnicodeScalarView.Element) -> String.UnicodeScalarView.Index? Returns the first index where the specified value appears in the collection.
func firstIndex (where: (String.UnicodeScalarView.Element) -> Bool) -> String.UnicodeScalarView.Index? Returns the first index in which an element of the collection satisfies the given predicate.
func flatMap <SegmentOfResult>((String.UnicodeScalarView.Element) -> SegmentOfResult) -> [SegmentOfResult.Element] Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func forEach ((String.UnicodeScalarView.Element) -> Void) Calls the given closure on each element in the sequence in the same order as a for-in loop.
func formIndex (inout String.UnicodeScalarView.Index, offsetBy : Int)Offsets the given index by the specified distance.
func formIndex (inout String.UnicodeScalarView.Index, offsetBy : Int, limitedBy : String.UnicodeScalarView.Index) -> Bool Offsets the given index by the specified distance, or so that it equals the given limiting index.
func formIndex (after: inout Substring.UnicodeScalarView.Index) Replaces the given index with its successor.
func formIndex (before: inout Substring.UnicodeScalarView.Index) Replaces the given index with its predecessor.
func index(Substring.UnicodeScalarView.Index, offsetBy : Int) -> Substring.UnicodeScalarView.Index Returns an index that is the specified distance from the given index.
func index(Substring.UnicodeScalarView.Index, offsetBy : Int, limitedBy : Substring.UnicodeScalarView.Index) -> Substring.UnicodeScalarView.Index? Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.
func index(after: Substring.UnicodeScalarView.Index) -> Substring.UnicodeScalarView.Index Returns the position immediately after the given index.
func index(before: Substring.UnicodeScalarView.Index) -> Substring.UnicodeScalarView.Index Returns the position immediately before the given index.
func index(of: String.UnicodeScalarView.Element) -> String.UnicodeScalarView.Index? Returns the first index where the specified value appears in the collection.
func index(where: (String.UnicodeScalarView.Element) -> Bool) -> String.UnicodeScalarView.Index? Returns the first index in which an element of the collection satisfies the given predicate.
func insert(String.UnicodeScalarView.Element, at: String.UnicodeScalarView.Index) Inserts a new element into the collection at the specified position.
func insert<C>(contentsOf : C, at: String.UnicodeScalarView.Index) Inserts the elements of a sequence into the collection at the specified position.
func last(where: (String.UnicodeScalarView.Element) -> Bool) -> String.UnicodeScalarView.Element? Returns the last element of the sequence that satisfies the given predicate.
func lastIndex (of: String.UnicodeScalarView.Element) -> String.UnicodeScalarView.Index? Returns the last index where the specified value appears in the collection.
func lastIndex (where: (String.UnicodeScalarView.Element) -> Bool) -> String.UnicodeScalarView.Index? 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: (String.UnicodeScalarView.Element, String.UnicodeScalarView.Element) -> 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<Substring.UnicodeScalarView> Returns an iterator over the elements of the collection.
func map<T>((String.UnicodeScalarView.Element) -> T) -> [T] Returns an array containing the results of mapping the given closure over the sequence’s elements.
func max() -> String.UnicodeScalarView.Element? Returns the maximum element in the sequence.
func max(by: (String.UnicodeScalarView.Element, String.UnicodeScalarView.Element) -> Bool) -> String.UnicodeScalarView.Element? Returns the maximum element in the sequence, using the given predicate as the comparison between elements.
func min() -> String.UnicodeScalarView.Element? Returns the minimum element in the sequence.
func min(by: (String.UnicodeScalarView.Element, String.UnicodeScalarView.Element) -> Bool) -> String.UnicodeScalarView.Element? Returns the minimum element in the sequence, using the given predicate as the comparison between elements.
func popFirst () -> String.UnicodeScalarView.Element? Removes and returns the first element of the collection.
func popLast () -> String.UnicodeScalarView.Element? Removes and returns the last element of the collection.
func prefix(Int) -> Substring.UnicodeScalarView Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through: String.UnicodeScalarView.Index) -> Substring.UnicodeScalarView Returns a subsequence from the start of the collection through the specified position.
func prefix(upTo : String.UnicodeScalarView.Index) -> Substring.UnicodeScalarView Returns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while: (String.UnicodeScalarView.Element) -> Bool) -> Substring.UnicodeScalarView Returns a subsequence containing the initial elements until predicate returns false and skipping the remaining elements.
func randomElement () -> String.UnicodeScalarView.Element? Returns a random element of the collection.
func randomElement <T>(using: inout T) -> String.UnicodeScalarView.Element? Returns a random element of the collection, using the given generator as a source for randomness.
func reduce<Result>(Result, (Result, String.UnicodeScalarView.Element) -> Result) -> Result Returns the result of combining the elements of the sequence using the given closure.
func reduce<Result>(into: Result, (inout Result, String.UnicodeScalarView.Element) -> ()) -> Result Returns the result of combining the elements of the sequence using the given closure.
func remove(at: String.UnicodeScalarView.Index) -> String.UnicodeScalarView.Element Removes and returns the element at the specified position.
func removeAll (keepingCapacity : Bool)Removes all elements from the collection.
func removeAll (where: (String.UnicodeScalarView.Element) -> Bool) Removes all the elements that satisfy the given predicate.
func removeFirst () -> String.UnicodeScalarView.Element Removes and returns the first element of the collection.
func removeFirst (Int)Removes the specified number of elements from the beginning of the collection.
func removeLast () -> String.UnicodeScalarView.Element Removes and returns the last element of the collection.
func removeLast (Int)Removes the specified number of elements from the end of the collection.
func removeSubrange <R>(R)Removes the elements in the specified subrange from the collection.
func removeSubrange (Range<String.UnicodeScalarView.Index>) Removes the elements in the specified subrange from the collection.
func replaceSubrange <C>(Range<Substring.UnicodeScalarView.Index>, with: C)Replaces the specified subrange of elements with the given collection.
func replaceSubrange <C, R>(R, with: C)Replaces the specified subrange of elements with the given collection.
func reserveCapacity (Int)Prepares the collection to store the specified number of elements, when doing so is appropriate for the underlying type.
func reversed() -> ReversedCollection<Substring.UnicodeScalarView> Returns a view presenting the elements of the collection in reverse order.
func shuffled() -> [String.UnicodeScalarView.Element] Returns the elements of the sequence, shuffled.
func shuffled<T>(using: inout T) -> [String.UnicodeScalarView.Element] Returns the elements of the sequence, shuffled using the given generator as a source for randomness.
func sorted() -> [String.UnicodeScalarView.Element] Returns the elements of the sequence, sorted.
func sorted(by: (String.UnicodeScalarView.Element, String.UnicodeScalarView.Element) -> Bool) -> [String.UnicodeScalarView.Element] Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.
func split(maxSplits : Int, omittingEmptySubsequences : Bool, whereSeparator : (String.UnicodeScalarView.Element) -> Bool) -> [Substring.UnicodeScalarView] Returns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.
func split(separator: String.UnicodeScalarView.Element, maxSplits : Int, omittingEmptySubsequences : Bool) -> [Substring.UnicodeScalarView] 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: (String.UnicodeScalarView.Element, 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) -> Substring.UnicodeScalarView Returns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from: String.UnicodeScalarView.Index) -> Substring.UnicodeScalarView Returns a subsequence from the specified position to the end of the collection.
func withContiguousStorageIfAvailable <R>((UnsafeBufferPointer<String.UnicodeScalarView.Element>) -> 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<Substring.UnicodeScalarView.Index>) -> Substring.UnicodeScalarView Accesses a contiguous subrange of the collection’s elements.
subscript<R>(R) -> Substring.UnicodeScalarView Accesses the contiguous subrange of the collection’s elements specified by a range expression.
subscript(Substring.UnicodeScalarView.Index) -> Substring.UnicodeScalarView.Element Accesses the element at the specified position.
Operator Functions
static func + <Other>(Other, Substring.UnicodeScalarView) -> Substring.UnicodeScalarView Creates a new collection by concatenating the elements of a sequence and a collection.
static func + <Other>(Substring.UnicodeScalarView, Other) -> Substring.UnicodeScalarView Creates a new collection by concatenating the elements of a collection and a sequence.
static func + <Other>(Substring.UnicodeScalarView, Other) -> Substring.UnicodeScalarView Creates a new collection by concatenating the elements of two collections.
static func += <Other>(inout Substring.UnicodeScalarView, Other) Appends the elements of a sequence to a range-replaceable collection.