No overview available.
SDK
- Xcode 9.0+
Framework
- Swift Standard Library
Declaration
@frozen struct UTF8View
StructureSubstring
Substring.UTF8View
Topics
Type Aliases
typealias Substring.UTF8View.Element A type representing the sequence’s elements.
typealias Substring.UTF8View.Index A type that represents a position in the collection.
typealias Substring.UTF8View.Indices A type that represents the indices that are valid for subscripting the collection, in ascending order.
typealias Substring.UTF8View.Iterator A type that provides the collection’s iteration interface and encapsulates its iteration state.
typealias Substring.UTF8View.SubSequence A sequence that represents a contiguous subrange of the collection’s elements.
Instance Properties
var count: IntThe number of elements in the collection.
var endIndex : Substring.UTF8View.Index The collection’s “past the end” position—that is, the position one greater than the last valid subscript argument.
var first: String.UTF8View.Element? The first element of the collection.
var indices: Substring.UTF8View.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.UTF8View.Element? The last element of the collection.
var lazy: LazySequence<Substring.UTF8View> 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.UTF8View.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.UTF8View.Element) -> Bool) -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func compactMap <ElementOfResult>((String.UTF8View.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.UTF8View.Element) -> Bool Returns a Boolean value indicating whether the sequence contains the given element.
func contains(where: (String.UTF8View.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.UTF8View.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.UTF8View.Element) -> Bool) -> CollectionDifference<String.UTF8View.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.UTF8View.Index, to: Substring.UTF8View.Index) -> Int Returns the distance between two indices.
func drop(while: (String.UTF8View.Element) -> Bool) -> Substring.UTF8View Returns a subsequence by skipping elements while predicate returns true and returning the remaining elements.
func dropFirst (Int) -> Substring.UTF8View Returns a subsequence containing all but the given number of initial elements.
func dropLast (Int) -> Substring.UTF8View 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.UTF8View.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.UTF8View> 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.UTF8View.Element) -> Bool) -> [String.UTF8View.Element] Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.
func first(where: (String.UTF8View.Element) -> Bool) -> String.UTF8View.Element? Returns the first element of the sequence that satisfies the given predicate.
func firstIndex (of: String.UTF8View.Element) -> String.UTF8View.Index? Returns the first index where the specified value appears in the collection.
func firstIndex (where: (String.UTF8View.Element) -> Bool) -> String.UTF8View.Index? Returns the first index in which an element of the collection satisfies the given predicate.
func flatMap <SegmentOfResult>((String.UTF8View.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.UTF8View.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.UTF8View.Index, offsetBy : Int)Offsets the given index by the specified distance.
func formIndex (inout String.UTF8View.Index, offsetBy : Int, limitedBy : String.UTF8View.Index) -> Bool Offsets the given index by the specified distance, or so that it equals the given limiting index.
func formIndex (after: inout Substring.UTF8View.Index) Replaces the given index with its successor.
func formIndex (before: inout Substring.UTF8View.Index) Replaces the given index with its predecessor.
func index(Substring.UTF8View.Index, offsetBy : Int) -> Substring.UTF8View.Index Returns an index that is the specified distance from the given index.
func index(Substring.UTF8View.Index, offsetBy : Int, limitedBy : Substring.UTF8View.Index) -> Substring.UTF8View.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.UTF8View.Index) -> Substring.UTF8View.Index Returns the position immediately after the given index.
func index(before: Substring.UTF8View.Index) -> Substring.UTF8View.Index Returns the position immediately before the given index.
func index(of: String.UTF8View.Element) -> String.UTF8View.Index? Returns the first index where the specified value appears in the collection.
func index(where: (String.UTF8View.Element) -> Bool) -> String.UTF8View.Index? Returns the first index in which an element of the collection satisfies the given predicate.
func last(where: (String.UTF8View.Element) -> Bool) -> String.UTF8View.Element? Returns the last element of the sequence that satisfies the given predicate.
func lastIndex (of: String.UTF8View.Element) -> String.UTF8View.Index? Returns the last index where the specified value appears in the collection.
func lastIndex (where: (String.UTF8View.Element) -> Bool) -> String.UTF8View.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.UTF8View.Element, String.UTF8View.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.UTF8View> Returns an iterator over the elements of the collection.
func map<T>((String.UTF8View.Element) -> T) -> [T] Returns an array containing the results of mapping the given closure over the sequence’s elements.
func max() -> String.UTF8View.Element? Returns the maximum element in the sequence.
func max(by: (String.UTF8View.Element, String.UTF8View.Element) -> Bool) -> String.UTF8View.Element? Returns the maximum element in the sequence, using the given predicate as the comparison between elements.
func min() -> String.UTF8View.Element? Returns the minimum element in the sequence.
func min(by: (String.UTF8View.Element, String.UTF8View.Element) -> Bool) -> String.UTF8View.Element? Returns the minimum element in the sequence, using the given predicate as the comparison between elements.
func popFirst () -> String.UTF8View.Element? Removes and returns the first element of the collection.
func popLast () -> String.UTF8View.Element? Removes and returns the last element of the collection.
func prefix(Int) -> Substring.UTF8View Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through: String.UTF8View.Index) -> Substring.UTF8View Returns a subsequence from the start of the collection through the specified position.
func prefix(upTo : String.UTF8View.Index) -> Substring.UTF8View Returns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while: (String.UTF8View.Element) -> Bool) -> Substring.UTF8View Returns a subsequence containing the initial elements until predicate returns false and skipping the remaining elements.
func randomElement () -> String.UTF8View.Element? Returns a random element of the collection.
func randomElement <T>(using: inout T) -> String.UTF8View.Element? Returns a random element of the collection, using the given generator as a source for randomness.
func reduce<Result>(Result, (Result, String.UTF8View.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.UTF8View.Element) -> ()) -> Result Returns the result of combining the elements of the sequence using the given closure.
func removeFirst () -> String.UTF8View.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.UTF8View.Element Removes and returns the last element of the collection.
func removeLast (Int)Removes the given number of elements from the end of the collection.
func reversed() -> ReversedCollection<Substring.UTF8View> Returns a view presenting the elements of the collection in reverse order.
func shuffled() -> [String.UTF8View.Element] Returns the elements of the sequence, shuffled.
func shuffled<T>(using: inout T) -> [String.UTF8View.Element] Returns the elements of the sequence, shuffled using the given generator as a source for randomness.
func sorted() -> [String.UTF8View.Element] Returns the elements of the sequence, sorted.
func sorted(by: (String.UTF8View.Element, String.UTF8View.Element) -> Bool) -> [String.UTF8View.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.UTF8View.Element) -> Bool) -> [Substring.UTF8View] Returns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.
func split(separator: String.UTF8View.Element, maxSplits : Int, omittingEmptySubsequences : Bool) -> [Substring.UTF8View] 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.UTF8View.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.UTF8View Returns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from: String.UTF8View.Index) -> Substring.UTF8View Returns a subsequence from the specified position to the end of the collection.
func withContiguousStorageIfAvailable <R>((UnsafeBufferPointer<String.UTF8View.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.UTF8View.Index>) -> Substring.UTF8View Accesses a contiguous subrange of the collection’s elements.
subscript<R>(R) -> Substring.UTF8View Accesses the contiguous subrange of the collection’s elements specified by a range expression.
subscript(Substring.UTF8View.Index) -> Substring.UTF8View.Element Accesses the element at the specified position.