Structureswift 6.0.1Swift
UnicodeScalarView
@frozen struct UnicodeScalarViewOther members in extension
View members
Hide members
This section is hidden by default because it contains too many (51) members.
Types
Typealiases
Show obsolete interfaces (1)
Hide obsolete interfaces
typealias CharacterViewA view of a string’s contents as a collection of characters.
Type members
init() Creates an empty substring.
init(Substring.UnicodeScalarView) Creates a Substring having the given content.
init(Substring.UTF8View) Creates a Substring having the given content.
init(Substring.UTF16View) Creates a Substring having the given content.
init(String) init<S>(S) init(cString: UnsafePointer<CChar>) init<C, Encoding>(decoding: C, as: Encoding.Type) init<Encoding>(decodingCString: UnsafePointer<Encoding.CodeUnit>, as: Encoding.Type) init(extendedGraphemeClusterLiteral: String) init(stringInterpolation: DefaultStringInterpolation) Creates a new instance from an interpolated string literal.
init(stringLiteral: String) init(unicodeScalarLiteral: String) static func ~= (lhs: Substring, rhs: String) -> Bool
Instance members
var base: StringReturns the underlying string from which this substring was derived.
var customMirror: Mirrorvar debugDescription: Stringvar description: Stringvar endIndex: Substring.Indexvar isContiguousUTF8: BoolReturns whether this string is capable of providing access to validly-encoded UTF-8 contents in contiguous memory in O(1) time.
var startIndex: Substring.Indexvar unicodeScalars: Substring.UnicodeScalarViewvar utf16: Substring.UTF16Viewvar utf8: Substring.UTF8Viewsubscript(Substring.Index) -> Character subscript(Range<Substring.Index>) -> Substring func append<S>(contentsOf: S) func distance(from: Substring.Index, to: Substring.Index) -> Int func filter((Substring.Element) throws -> Bool) rethrows -> String func index(Substring.Index, offsetBy: Int) -> Substring.Index func index(Substring.Index, offsetBy: Int, limitedBy: Substring.Index) -> Substring.Index? func index(after: Substring.Index) -> Substring.Index func index(before: Substring.Index) -> Substring.Index func lowercased() -> String func makeContiguousUTF8() If this string is not contiguous, make it so. If this mutates the substring, it will invalidate any pre-existing indices.
func replaceSubrange(Range<Substring.Index>, with: Substring) func replaceSubrange<C>(Range<Substring.Index>, with: C) func uppercased() -> String func withCString<Result>((UnsafePointer<CChar>) throws -> Result) rethrows -> Result func withCString<Result, TargetEncoding>(encodedAs: TargetEncoding.Type, (UnsafePointer<TargetEncoding.CodeUnit>) throws -> Result) rethrows -> Result func withUTF8<R>((UnsafeBufferPointer<UInt8>) throws -> R) rethrows -> R Runs
bodyover the content of this substring in contiguous memory. If this substring is not contiguous, this will first make it contiguous, which will also speed up subsequent access. If this mutates the substring, it will invalidate any pre-existing indices.func write(String) func write<Target>(to: inout Target)
Show obsolete interfaces (3)
Hide obsolete interfaces
var characters: SubstringA view of the string’s contents as a collection of characters.
var customPlaygroundQuickLook: _PlaygroundQuickLookfunc withMutableCharacters<R>((inout Substring) -> R) -> R Applies the given closure to a mutable view of the string’s characters.
Citizens in Swift
Conformances
protocol BidirectionalCollection<Element>A collection that supports backward as well as forward traversal.
protocol Collection<Element>A sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol Escapableprotocol RangeReplaceableCollection<Element>A collection that supports replacement of an arbitrary subrange of elements with the elements of another collection.
protocol Sendableprotocol Sequence<Element>A type that provides sequential, iterated access to its elements.
Typealiases
Type members
Instance members
var endIndex: Substring.UnicodeScalarView.Indexvar indices: Substring.UnicodeScalarView.Indicesvar startIndex: Substring.UnicodeScalarView.Indexsubscript(Range<Substring.UnicodeScalarView.Index>) -> Substring.UnicodeScalarView subscript(Substring.UnicodeScalarView.Index) -> Substring.UnicodeScalarView.Element func distance(from: Substring.UnicodeScalarView.Index, to: Substring.UnicodeScalarView.Index) -> Int func formIndex(after: inout Substring.UnicodeScalarView.Index) func formIndex(before: inout Substring.UnicodeScalarView.Index) func index(Substring.UnicodeScalarView.Index, offsetBy: Int) -> Substring.UnicodeScalarView.Index func index(Substring.UnicodeScalarView.Index, offsetBy: Int, limitedBy: Substring.UnicodeScalarView.Index) -> Substring.UnicodeScalarView.Index? func index(after: Substring.UnicodeScalarView.Index) -> Substring.UnicodeScalarView.Index func index(before: Substring.UnicodeScalarView.Index) -> Substring.UnicodeScalarView.Index func replaceSubrange<C>(Range<Substring.UnicodeScalarView.Index>, with: C)
Type features
init<S>(S) Creates a new instance of a collection containing the elements of a sequence.
init(repeating: Self.Element, count: Int) Creates a new collection containing the specified number of a single, repeated value.
static func + <Other>(lhs: Other, rhs: Self) -> Self Creates a new collection by concatenating the elements of a sequence and a collection.
static func + <Other>(lhs: Self, rhs: Other) -> Self Creates a new collection by concatenating the elements of a collection and a sequence.
static func + <Other>(lhs: Self, rhs: Other) -> Self Creates a new collection by concatenating the elements of two collections.
static func += <Other>(lhs: inout Self, rhs: Other) Appends the elements of a sequence to a range-replaceable collection.
Instance features
var count: IntThe number of elements in the collection.
var first: Self.Element?The first element of the collection.
var isEmpty: BoolA Boolean value indicating whether the collection is empty.
var last: Self.Element?The last element of the collection.
var lazy: LazySequence<Self>A sequence containing the same elements as this sequence, but on which some operations, such as
mapandfilter, are implemented lazily.var underestimatedCount: IntA value less than or equal to the number of elements in the collection.
subscript<R>(R) -> Self.SubSequence Accesses the contiguous subrange of the collection’s elements specified by a range expression.
subscript((UnboundedRange_) -> ()) -> Self.SubSequence subscript(RangeSet<Self.Index>) -> DiscontiguousSlice<Self> Accesses a view of this collection with the elements at the given indices.
func allSatisfy((Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func append(Self.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<Self.Element>) -> Self? Applies the given difference to this collection.
func compactMap<ElementOfResult>((Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] Returns an array containing the non-
nilresults of calling the given transformation with each element of this sequence.func contains(Self.Element) -> Bool Returns a Boolean value indicating whether the sequence contains the given element.
func contains(where: (Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func count<E>(where: (Self.Element)throws Returns the number of elements in the sequence that satisfy the given predicate.
func difference<C>(from: C) -> CollectionDifference<Self.Element> Returns the difference needed to produce this collection’s ordered elements from the given collection.
func difference<C>(from: C, by: (C.Element, Self.Element) -> Bool) -> CollectionDifference<Self.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 drop(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence by skipping elements while
predicatereturnstrueand returning the remaining elements.func dropFirst(Int) -> Self.SubSequence Returns a subsequence containing all but the given number of initial elements.
func dropLast(Int) -> Self.SubSequence 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: (Self.Element, OtherSequence.Element) throws -> Bool) rethrows -> 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<Self> 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((Self.Element) throws -> Bool) rethrows -> Self 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: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the first element of the sequence that satisfies the given predicate.
func firstIndex(of: Self.Element) -> Self.Index? Returns the first index where the specified value appears in the collection.
func firstIndex(where: (Self.Element) throws -> Bool) rethrows -> Self.Index? Returns the first index in which an element of the collection satisfies the given predicate.
func flatMap<SegmentOfResult>((Self.Element) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Element] Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func forEach((Self.Element) throws -> Void) rethrows Calls the given closure on each element in the sequence in the same order as a
for-inloop.func formIndex(inout Self.Index, offsetBy: Int) Offsets the given index by the specified distance.
func formIndex(inout Self.Index, offsetBy: Int, limitedBy: Self.Index) -> Bool Offsets the given index by the specified distance, or so that it equals the given limiting index.
func indices(of: Self.Element) -> RangeSet<Self.Index> Returns the indices of all the elements that are equal to the given element.
func indices(where: (Self.Element) throws -> Bool) rethrows -> RangeSet<Self.Index> Returns the indices of all the elements that match the given predicate.
func insert(Self.Element, at: Self.Index) Inserts a new element into the collection at the specified position.
func insert<C>(contentsOf: C, at: Self.Index) Inserts the elements of a sequence into the collection at the specified position.
func last(where: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the last element of the sequence that satisfies the given predicate.
func lastIndex(of: Self.Element) -> Self.Index? Returns the last index where the specified value appears in the collection.
func lastIndex(where: (Self.Element) throws -> Bool) rethrows -> Self.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: (Self.Element, Self.Element) throws -> Bool) rethrows -> 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<Self> Returns an iterator over the elements of the collection.
func map<T, E>((Self.Element)throws Returns an array containing the results of mapping the given closure over the sequence’s elements.
func map<T, E>((Self.Element)throws Returns an array containing the results of mapping the given closure over the sequence’s elements.
func max() -> Self.Element? Returns the maximum element in the sequence.
func max(by: (Self.Element, Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the maximum element in the sequence, using the given predicate as the comparison between elements.
func min() -> Self.Element? Returns the minimum element in the sequence.
func min(by: (Self.Element, Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the minimum element in the sequence, using the given predicate as the comparison between elements.
func popFirst() -> Self.Element? Removes and returns the first element of the collection.
func popLast() -> Self.Element? Removes and returns the last element of the collection.
func popLast() -> Self.Element? Removes and returns the last element of the collection.
func popLast() -> Self.Element? Removes and returns the last element of the collection.
func prefix(Int) -> Self.SubSequence Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection through the specified position.
func prefix(upTo: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence containing the initial elements until
predicatereturnsfalseand skipping the remaining elements.func randomElement() -> Self.Element? Returns a random element of the collection.
func randomElement<T>(using: inout T) -> Self.Element? Returns a random element of the collection, using the given generator as a source for randomness.
func reduce<Result>(Result, (Result, Self.Element) throws -> Result) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
func reduce<Result>(into: Result, (inout Result, Self.Element) throws -> ()) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
func remove(at: Self.Index) -> Self.Element Removes and returns the element at the specified position.
func removeAll(keepingCapacity: Bool) Removes all elements from the collection.
func removeAll(where: (Self.Element) throws -> Bool) rethrows Removes all the elements that satisfy the given predicate.
func removeFirst() -> Self.Element Removes and returns the first element of the collection.
func removeFirst() -> Self.Element Removes and returns the first element of the collection.
func removeFirst() -> Self.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 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.
func removeLast() -> Self.Element Removes and returns the last element of the collection.
func removeLast() -> Self.Element Removes and returns the last element of the collection.
func removeLast() -> Self.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 removeLast(Int) Removes the specified number of elements from the end of the collection.
func removeLast(Int) Removes the specified number of elements from the end of the collection.
func removeSubrange(Range<Self.Index>) Removes the elements in the specified subrange from the collection.
func removeSubrange<R>(R) Removes the elements in the specified subrange from the collection.
func removeSubranges(RangeSet<Self.Index>) Removes the elements at the given indices.
func removingSubranges(RangeSet<Self.Index>) -> DiscontiguousSlice<Self> Returns a collection of the elements in this collection that are not represented by the given range set.
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<Self> Returns a view presenting the elements of the collection in reverse order.
func shuffled() -> [Self.Element] Returns the elements of the sequence, shuffled.
func shuffled<T>(using: inout T) -> [Self.Element] Returns the elements of the sequence, shuffled using the given generator as a source for randomness.
func sorted() -> [Self.Element] Returns the elements of the sequence, sorted.
func sorted(by: (Self.Element, Self.Element) throws -> Bool) rethrows -> [Self.Element] Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.
func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (Self.Element) throws -> Bool) rethrows -> [Self.SubSequence] Returns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.
func split(separator: Self.Element, maxSplits: Int, omittingEmptySubsequences: Bool) -> [Self.SubSequence] 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: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> 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) -> Self.SubSequence Returns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from: Self.Index) -> Self.SubSequence Returns a subsequence from the specified position to the end of the collection.
func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<Self.Element>) throws -> R) rethrows -> R?
Show obsolete interfaces (2)
Hide obsolete interfaces
func flatMap<ElementOfResult>((Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] func index(of: Self.Element) -> Self.Index? Returns the first index where the specified value appears in the collection.