Structureswift 6.0.1FoundationEssentials
CharacterView
- iOS
- 15+
- macOS
- 12+
- tvOS
- 15+
- watchOS
- 8+
struct CharacterViewstruct CharacterViews20FoundationEssentials16AttributedStringV13CharacterViewV What are these?3ME8Dimport FoundationEssentials@dynamicMemberLookup struct AttributedStringinit() init(_ substring: AttributedSubstring) init(_ string: String, attributes: AttributeContainer = .init()) Creates a new attributed string with the given String value associated with the given attributes.
init(_ substring: Substring, attributes: AttributeContainer = .init()) Creates a new attributed string with the given Substring value associated with the given attributes.
init<S>(_ elements: S, attributes: AttributeContainer = .init()) where S : Sequence, S.Element == Character init(stringLiteral value: String) var characters: AttributedString.CharacterView { get set }var endIndex: AttributedString.Index { get }var runs: AttributedString.Runs { get }var startIndex: AttributedString.Index { get }var unicodeScalars: AttributedString.UnicodeScalarView { get set }@preconcurrency subscript<K>(_: K.Type) -> K.Value? where K : AttributedStringKey, K.Value : Sendable { get set } subscript(bounds: some RangeExpression<AttributedString.Index>) -> AttributedSubstring { get set } @preconcurrency subscript<K>(dynamicMember keyPath: KeyPath<AttributeDynamicLookup, K>) -> K.Value? where K : AttributedStringKey, K.Value : Sendable { get set } subscript<S>(dynamicMember keyPath: KeyPath<AttributeScopes, S.Type>) -> ScopedAttributeContainer<S> where S : AttributeScope { get set } static func + (lhs: AttributedString, rhs: AttributedString) -> AttributedString static func + (lhs: AttributedString, rhs: some AttributedStringProtocol) -> AttributedString static func += (lhs: inout AttributedString, rhs: AttributedString) static func += (lhs: inout AttributedString, rhs: some AttributedStringProtocol) static func == (lhs: AttributedString, rhs: AttributedString) -> Bool mutating func append(_ s: some AttributedStringProtocol) mutating func insert(_ s: some AttributedStringProtocol, at index: AttributedString.Index) mutating func mergeAttributes(_ attributes: AttributeContainer, mergePolicy: AttributedString.AttributeMergePolicy = .keepNew) mutating func removeSubrange(_ range: some RangeExpression<AttributedString.Index>) mutating func replaceAttributes(_ attributes: AttributeContainer, with others: AttributeContainer) mutating func replaceSubrange(_ range: some RangeExpression<AttributedString.Index>, with s: some AttributedStringProtocol) mutating func setAttributes(_ attributes: AttributeContainer) @preconcurrency func transformingAttributes<K>(_ k: KeyPath<AttributeDynamicLookup, K>, _ c: (inout AttributedString.SingleAttributeTransformer<K>) -> Void) -> AttributedString where K : AttributedStringKey, K.Value : Sendable @preconcurrency func transformingAttributes<K>(_ k: K.Type, _ c: (inout AttributedString.SingleAttributeTransformer<K>) -> Void) -> AttributedString where K : AttributedStringKey, K.Value : Sendable @preconcurrency func transformingAttributes<K1, K2>(_ k: KeyPath<AttributeDynamicLookup, K1>, _ k2: KeyPath<AttributeDynamicLookup, K2>, _ c: (inout AttributedString.SingleAttributeTransformer<K1>, inout AttributedString.SingleAttributeTransformer<K2>) -> Void) -> AttributedString where K1 : AttributedStringKey, K2 : AttributedStringKey, K1.Value : Sendable, K2.Value : Sendable @preconcurrency func transformingAttributes<K1, K2>(_ k: K1.Type, _ k2: K2.Type, _ c: (inout AttributedString.SingleAttributeTransformer<K1>, inout AttributedString.SingleAttributeTransformer<K2>) -> Void) -> AttributedString where K1 : AttributedStringKey, K2 : AttributedStringKey, K1.Value : Sendable, K2.Value : Sendable @preconcurrency func transformingAttributes<K1, K2, K3>(_ k: KeyPath<AttributeDynamicLookup, K1>, _ k2: KeyPath<AttributeDynamicLookup, K2>, _ k3: KeyPath<AttributeDynamicLookup, K3>, _ c: (inout AttributedString.SingleAttributeTransformer<K1>, inout AttributedString.SingleAttributeTransformer<K2>, inout AttributedString.SingleAttributeTransformer<K3>) -> Void) -> AttributedString where K1 : AttributedStringKey, K2 : AttributedStringKey, K3 : AttributedStringKey, K1.Value : Sendable, K2.Value : Sendable, K3.Value : Sendable @preconcurrency func transformingAttributes<K1, K2, K3>(_ k: K1.Type, _ k2: K2.Type, _ k3: K3.Type, _ c: (inout AttributedString.SingleAttributeTransformer<K1>, inout AttributedString.SingleAttributeTransformer<K2>, inout AttributedString.SingleAttributeTransformer<K3>) -> Void) -> AttributedString where K1 : AttributedStringKey, K2 : AttributedStringKey, K3 : AttributedStringKey, K1.Value : Sendable, K2.Value : Sendable, K3.Value : Sendable @preconcurrency func transformingAttributes<K1, K2, K3, K4>(_ k: KeyPath<AttributeDynamicLookup, K1>, _ k2: KeyPath<AttributeDynamicLookup, K2>, _ k3: KeyPath<AttributeDynamicLookup, K3>, _ k4: KeyPath<AttributeDynamicLookup, K4>, _ c: (inout AttributedString.SingleAttributeTransformer<K1>, inout AttributedString.SingleAttributeTransformer<K2>, inout AttributedString.SingleAttributeTransformer<K3>, inout AttributedString.SingleAttributeTransformer<K4>) -> Void) -> AttributedString where K1 : AttributedStringKey, K2 : AttributedStringKey, K3 : AttributedStringKey, K4 : AttributedStringKey, K1.Value : Sendable, K2.Value : Sendable, K3.Value : Sendable, K4.Value : Sendable @preconcurrency func transformingAttributes<K1, K2, K3, K4>(_ k: K1.Type, _ k2: K2.Type, _ k3: K3.Type, _ k4: K4.Type, _ c: (inout AttributedString.SingleAttributeTransformer<K1>, inout AttributedString.SingleAttributeTransformer<K2>, inout AttributedString.SingleAttributeTransformer<K3>, inout AttributedString.SingleAttributeTransformer<K4>) -> Void) -> AttributedString where K1 : AttributedStringKey, K2 : AttributedStringKey, K3 : AttributedStringKey, K4 : AttributedStringKey, K1.Value : Sendable, K2.Value : Sendable, K3.Value : Sendable, K4.Value : Sendable @preconcurrency func transformingAttributes<K1, K2, K3, K4, K5>(_ k: KeyPath<AttributeDynamicLookup, K1>, _ k2: KeyPath<AttributeDynamicLookup, K2>, _ k3: KeyPath<AttributeDynamicLookup, K3>, _ k4: KeyPath<AttributeDynamicLookup, K4>, _ k5: KeyPath<AttributeDynamicLookup, K5>, _ c: (inout AttributedString.SingleAttributeTransformer<K1>, inout AttributedString.SingleAttributeTransformer<K2>, inout AttributedString.SingleAttributeTransformer<K3>, inout AttributedString.SingleAttributeTransformer<K4>, inout AttributedString.SingleAttributeTransformer<K5>) -> Void) -> AttributedString where K1 : AttributedStringKey, K2 : AttributedStringKey, K3 : AttributedStringKey, K4 : AttributedStringKey, K5 : AttributedStringKey, K1.Value : Sendable, K2.Value : Sendable, K3.Value : Sendable, K4.Value : Sendable, K5.Value : Sendable @preconcurrency func transformingAttributes<K1, K2, K3, K4, K5>(_ k: K1.Type, _ k2: K2.Type, _ k3: K3.Type, _ k4: K4.Type, _ k5: K5.Type, _ c: (inout AttributedString.SingleAttributeTransformer<K1>, inout AttributedString.SingleAttributeTransformer<K2>, inout AttributedString.SingleAttributeTransformer<K3>, inout AttributedString.SingleAttributeTransformer<K4>, inout AttributedString.SingleAttributeTransformer<K5>) -> Void) -> AttributedString where K1 : AttributedStringKey, K2 : AttributedStringKey, K3 : AttributedStringKey, K4 : AttributedStringKey, K5 : AttributedStringKey, K1.Value : Sendable, K2.Value : Sendable, K3.Value : Sendable, K4.Value : Sendable, K5.Value : Sendable struct AttributeInvalidationConditionenum AttributeMergePolicyenum AttributeRunBoundariesstruct Indexstruct Runs@preconcurrency struct SingleAttributeTransformer<T> where T : AttributedStringKey, T.Value : Sendablestruct UnicodeScalarViewprotocol BidirectionalCollection<Element> : Collection where Self.Indices : BidirectionalCollection, Self.SubSequence : BidirectionalCollectionA collection that supports backward as well as forward traversal.
protocol Collection<Element> : SequenceA 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> : Collection where Self.SubSequence : RangeReplaceableCollectionA 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.
init() var count: Int { get }var endIndex: AttributedString.Index { get }var startIndex: AttributedString.Index { get }subscript(index: AttributedString.Index) -> Character { get set } subscript(bounds: Range<AttributedString.Index>) -> Slice<AttributedString.CharacterView> { get set } func distance(from start: AttributedString.Index, to end: AttributedString.Index) -> Int func index(_ i: AttributedString.Index, offsetBy distance: Int) -> AttributedString.Index func index(_ i: AttributedString.Index, offsetBy distance: Int, limitedBy limit: AttributedString.Index) -> AttributedString.Index? func index(after i: AttributedString.Index) -> AttributedString.Index func index(before i: AttributedString.Index) -> AttributedString.Index mutating func replaceSubrange(_ subrange: Range<AttributedString.CharacterView.Index>, with newElements: some Collection<Character>) typealias Element = Charactertypealias Index = AttributedString.Indexinit<S>(_ elements: S) where S : Sequence, Self.Element == S.Element Creates a new instance of a collection containing the elements of a sequence.
init(repeating repeatedValue: Self.Element, count: Int) Creates a new collection containing the specified number of a single, repeated value.
var first: Self.Element? { get }The first element of the collection.
var indices: DefaultIndices<Self> { get }The indices that are valid for subscripting the collection, in ascending order.
var isEmpty: Bool { get }A Boolean value indicating whether the collection is empty.
var last: Self.Element? { get }The last element of the collection.
var lazy: LazySequence<Self> { get }A sequence containing the same elements as this sequence, but on which some operations, such as map and filter, are implemented lazily.
var underestimatedCount: Int { get }A value less than or equal to the number of elements in the collection.
subscript<R>(r: R) -> Self.SubSequence where R : RangeExpression, Self.Index == R.Bound { get } Accesses the contiguous subrange of the collection’s elements specified by a range expression.
subscript(x: (UnboundedRange_) -> ()) -> Self.SubSequence { get } subscript(subranges: RangeSet<Self.Index>) -> DiscontiguousSlice<Self> { get } Accesses a view of this collection with the elements at the given indices.
subscript(bounds: Range<Self.Index>) -> Slice<Self> { get } Accesses a contiguous subrange of the collection’s elements.
static func + <Other>(lhs: Other, rhs: Self) -> Self where Other : Sequence, Self.Element == Other.Element Creates a new collection by concatenating the elements of a sequence and a collection.
static func + <Other>(lhs: Self, rhs: Other) -> Self where Other : Sequence, Self.Element == Other.Element Creates a new collection by concatenating the elements of a collection and a sequence.
static func + <Other>(lhs: Self, rhs: Other) -> Self where Other : RangeReplaceableCollection, Self.Element == Other.Element Creates a new collection by concatenating the elements of two collections.
static func += <Other>(lhs: inout Self, rhs: Other) where Other : Sequence, Self.Element == Other.Element Appends the elements of a sequence to a range-replaceable collection.
func allSatisfy(_ predicate: (Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
mutating func append(_ newElement: Self.Element) Adds an element to the end of the collection.
mutating func append<S>(contentsOf newElements: S) where S : Sequence, Self.Element == S.Element Adds the elements of a sequence or collection to the end of this collection.
func applying(_ difference: CollectionDifference<Self.Element>) -> Self? Applies the given difference to this collection.
func compactMap<ElementOfResult>(_ transform: (Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] Returns an array containing the non-nil results of calling the given transformation with each element of this sequence.
func compare<Comparator>(_ lhs: Comparator.Compared, _ rhs: Comparator.Compared) -> ComparisonResult where Comparator : SortComparator, Comparator == Self.Element If lhs is ordered before rhs in the ordering described by the given sequence of SortComparators
func contains(_ element: Self.Element) -> Bool Returns a Boolean value indicating whether the sequence contains the given element.
func contains(where predicate: (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 predicate: (Self.Element) throws(E) -> Bool) throws(E) -> Int where E : Error Returns the number of elements in the sequence that satisfy the given predicate.
func difference<C>(from other: C) -> CollectionDifference<Self.Element> where C : BidirectionalCollection, Self.Element == C.Element Returns the difference needed to produce this collection’s ordered elements from the given collection.
func difference<C>(from other: C, by areEquivalent: (C.Element, Self.Element) -> Bool) -> CollectionDifference<Self.Element> where C : BidirectionalCollection, Self.Element == C.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 predicate: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence by skipping elements while predicate returns true and returning the remaining elements.
func dropFirst(_ k: Int = 1) -> Self.SubSequence Returns a subsequence containing all but the given number of initial elements.
func dropLast(_ k: Int) -> Self.SubSequence Returns a subsequence containing all but the specified number of final elements.
func elementsEqual<OtherSequence>(_ other: OtherSequence) -> Bool where OtherSequence : Sequence, Self.Element == OtherSequence.Element Returns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.
func elementsEqual<OtherSequence>(_ other: OtherSequence, by areEquivalent: (Self.Element, OtherSequence.Element) throws -> Bool) rethrows -> Bool where OtherSequence : Sequence 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(_ isIncluded: (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 predicate: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the first element of the sequence that satisfies the given predicate.
func firstIndex(of element: Self.Element) -> Self.Index? Returns the first index where the specified value appears in the collection.
func firstIndex(where predicate: (Self.Element) throws -> Bool) rethrows -> Self.Index? Returns the first index in which an element of the collection satisfies the given predicate.
func firstRange<C>(of other: C) -> Range<Self.Index>? where C : Collection, Self.Element == C.Element Finds and returns the range of the first occurrence of a given collection within this collection.
func firstRange<C>(of other: C) -> Range<Self.Index>? where C : Collection, Self.Element == C.Element Finds and returns the range of the first occurrence of a given collection within this collection.
func flatMap<SegmentOfResult>(_ transform: (Self.Element) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Element] where SegmentOfResult : Sequence Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func forEach(_ body: (Self.Element) throws -> Void) rethrows Calls the given closure on each element in the sequence in the same order as a for-in loop.
func formIndex(_ i: inout Self.Index, offsetBy distance: Int) Offsets the given index by the specified distance.
func formIndex(_ i: inout Self.Index, offsetBy distance: Int, limitedBy limit: Self.Index) -> Bool Offsets the given index by the specified distance, or so that it equals the given limiting index.
func formIndex(after i: inout Self.Index) Replaces the given index with its successor.
func formIndex(before i: inout Self.Index) func indices(of element: Self.Element) -> RangeSet<Self.Index> Returns the indices of all the elements that are equal to the given element.
func indices(where predicate: (Self.Element) throws -> Bool) rethrows -> RangeSet<Self.Index> Returns the indices of all the elements that match the given predicate.
mutating func insert(_ newElement: Self.Element, at i: Self.Index) Inserts a new element into the collection at the specified position.
mutating func insert<C>(contentsOf newElements: C, at i: Self.Index) where C : Collection, Self.Element == C.Element Inserts the elements of a sequence into the collection at the specified position.
func last(where predicate: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the last element of the sequence that satisfies the given predicate.
func lastIndex(of element: Self.Element) -> Self.Index? Returns the last index where the specified value appears in the collection.
func lastIndex(where predicate: (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>(_ other: OtherSequence) -> Bool where OtherSequence : Sequence, Self.Element == OtherSequence.Element 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>(_ other: OtherSequence, by areInIncreasingOrder: (Self.Element, Self.Element) throws -> Bool) rethrows -> Bool where OtherSequence : Sequence, Self.Element == OtherSequence.Element 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>(_ transform: (Self.Element) throws(E) -> T) throws(E) -> [T] where E : Error Returns an array containing the results of mapping the given closure over the sequence’s elements.
func map<T, E>(_ transform: (Self.Element) throws(E) -> T) throws(E) -> [T] where E : Error Returns an array containing the results of mapping the given closure over the sequence’s elements.
@warn_unqualified_access func max() -> Self.Element? Returns the maximum element in the sequence.
@warn_unqualified_access func max(by areInIncreasingOrder: (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.
@warn_unqualified_access func min() -> Self.Element? Returns the minimum element in the sequence.
@warn_unqualified_access func min(by areInIncreasingOrder: (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.
mutating func popLast() -> Self.Element? Removes and returns the last element of the collection.
func prefix(_ maxLength: Int) -> Self.SubSequence Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through position: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection through the specified position.
func prefix(upTo end: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while predicate: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence containing the initial elements until predicate returns false and skipping the remaining elements.
func randomElement() -> Self.Element? Returns a random element of the collection.
func randomElement<T>(using generator: inout T) -> Self.Element? where T : RandomNumberGenerator Returns a random element of the collection, using the given generator as a source for randomness.
func ranges<C>(of other: C) -> [Range<Self.Index>] where C : Collection, Self.Element == C.Element Finds and returns the ranges of the all occurrences of a given sequence within the collection.
func reduce<Result>(_ initialResult: Result, _ nextPartialResult: (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 initialResult: Result, _ updateAccumulatingResult: (inout Result, Self.Element) throws -> ()) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
@discardableResult mutating func remove(at position: Self.Index) -> Self.Element Removes and returns the element at the specified position.
mutating func removeAll(keepingCapacity keepCapacity: Bool = false) Removes all elements from the collection.
mutating func removeAll(where shouldBeRemoved: (Self.Element) throws -> Bool) rethrows Removes all the elements that satisfy the given predicate.
@discardableResult mutating func removeFirst() -> Self.Element Removes and returns the first element of the collection.
mutating func removeFirst(_ k: Int) Removes the specified number of elements from the beginning of the collection.
@discardableResult mutating func removeLast() -> Self.Element Removes and returns the last element of the collection.
mutating func removeLast(_ k: Int) Removes the specified number of elements from the end of the collection.
mutating func removeSubrange(_ bounds: Range<Self.Index>) Removes the elements in the specified subrange from the collection.
mutating func removeSubrange<R>(_ bounds: R) where R : RangeExpression, Self.Index == R.Bound Removes the elements in the specified subrange from the collection.
mutating func removeSubranges(_ subranges: RangeSet<Self.Index>) Removes the elements at the given indices.
func removingSubranges(_ subranges: RangeSet<Self.Index>) -> DiscontiguousSlice<Self> Returns a collection of the elements in this collection that are not represented by the given range set.
mutating func replace<C, Replacement>(_ other: C, with replacement: Replacement, maxReplacements: Int = .max) where C : Collection, Replacement : Collection, Self.Element == C.Element, C.Element == Replacement.Element Replaces all occurrences of a target sequence with a given collection
mutating func replaceSubrange<C, R>(_ subrange: R, with newElements: C) where C : Collection, R : RangeExpression, Self.Element == C.Element, Self.Index == R.Bound Replaces the specified subrange of elements with the given collection.
func replacing<C, Replacement>(_ other: C, with replacement: Replacement, maxReplacements: Int = .max) -> Self where C : Collection, Replacement : Collection, Self.Element == C.Element, C.Element == Replacement.Element Returns a new collection in which all occurrences of a target sequence are replaced by another collection.
func replacing<C, Replacement>(_ other: C, with replacement: Replacement, subrange: Range<Self.Index>, maxReplacements: Int = .max) -> Self where C : Collection, Replacement : Collection, Self.Element == C.Element, C.Element == Replacement.Element Returns a new collection in which all occurrences of a target sequence are replaced by another collection.
mutating func reserveCapacity(_ n: 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 generator: inout T) -> [Self.Element] where T : RandomNumberGenerator 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 areInIncreasingOrder: (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 sorted<Comparator>(using comparator: Comparator) -> [Self.Element] where Comparator : SortComparator, Self.Element == Comparator.Compared Returns the elements of the sequence, sorted using the given comparator to compare elements.
func sorted<S, Comparator>(using comparators: S) -> [Self.Element] where S : Sequence, Comparator : SortComparator, Comparator == S.Element, Self.Element == Comparator.Compared Returns the elements of the sequence, sorted using the given array of SortComparators to compare elements.
func split(maxSplits: Int = Int.max, omittingEmptySubsequences: Bool = true, whereSeparator isSeparator: (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 = Int.max, omittingEmptySubsequences: Bool = true) -> [Self.SubSequence] Returns the longest possible subsequences of the collection, in order, around elements equal to the given element.
func starts<PossiblePrefix>(with possiblePrefix: PossiblePrefix) -> Bool where PossiblePrefix : Sequence, Self.Element == PossiblePrefix.Element 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: PossiblePrefix, by areEquivalent: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> Bool where PossiblePrefix : Sequence 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(_ maxLength: Int) -> Self.SubSequence Returns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from start: Self.Index) -> Self.SubSequence Returns a subsequence from the specified position to the end of the collection.
mutating func trimPrefix<Prefix>(_ prefix: Prefix) where Prefix : Sequence, Self.Element == Prefix.Element Removes prefix from the start of the collection.
mutating func trimPrefix(while predicate: (Self.Element) throws -> Bool) rethrows func trimmingPrefix<Prefix>(_ prefix: Prefix) -> Self.SubSequence where Prefix : Sequence, Self.Element == Prefix.Element Returns a new collection of the same type by removing prefix from the start of the collection.
func trimmingPrefix(while predicate: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence func withContiguousStorageIfAvailable<R>(_ body: (UnsafeBufferPointer<Self.Element>) throws -> R) rethrows -> R? func flatMap<ElementOfResult>(_ transform: (Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] func index(of element: Self.Element) -> Self.Index? Returns the first index where the specified value appears in the collection.
import Foundationfunc formatted<S>(_ style: S) -> S.FormatOutput where Self == S.FormatInput, S : FormatStyle import VaporVapor is a framework for building server applications, APIs and websites in Swift. It provides a safe, performant and scalable foundation for building large complex backends.
func adjacentPairs() -> AdjacentPairsCollection<Self> Returns a collection of overlapping adjacent pairs of the elements of this collection.
func chunked(by belongInSameGroup: (Element, Element) throws -> Bool) rethrows -> [SubSequence] Returns a collection of subsequences of this collection, chunked by the given predicate.
func chunked<Subject>(on projection: (Element) throws -> Subject) rethrows -> [(Subject, SubSequence)] where Subject : Equatable Returns a collection of subsequences of this collection, chunked by grouping elements that project to equal values.
func chunks(ofCount count: Int) -> ChunksOfCountCollection<Self> Returns a collection of subsequences, each with up to the specified length.
func combinations(ofCount k: Int) -> CombinationsSequence<Self> Returns a collection of combinations of this collection’s elements, with each combination having the specified number of elements.
func compacted<Unwrapped>() -> CompactedSequence<Self, Unwrapped> where Self.Element == Unwrapped? Returns a new Sequence that iterates over every non-nil element from the original Sequence.
func compacted<Unwrapped>() -> CompactedCollection<Self, Unwrapped> where Self.Element == Unwrapped? Returns a new Collection that iterates over every non-nil element from the original Collection.
func cycled() -> CycledSequence<Self> Returns a sequence that repeats the elements of this collection forever.
func cycled(times: Int) -> CycledTimesCollection<Self> Returns a sequence that repeats the elements of this collection the specified number of times.
func endOfPrefix(while predicate: (Element) throws -> Bool) rethrows -> Index Returns the exclusive upper bound of the prefix of elements that satisfy the predicate.
func evenlyChunked(in count: Int) -> EvenlyChunkedCollection<Self> Returns a collection of evenly divided consecutive subsequences of this collection.
func firstNonNil<Result>(_ transform: (Element) throws -> Result?) rethrows -> Result? Returns the first non-nil result obtained from applying the given transformation to the elements of the sequence.
func flatten<Value>(on eventLoop: EventLoop) -> EventLoopFuture<[Value]> where Self.Element == EventLoopFuture<Value> Converts a collection of EventLoopFutures to an EventLoopFuture that wraps an array with the future values.
func grouped<GroupKey>(by keyForValue: (Element) throws -> GroupKey) rethrows -> [GroupKey : [Element]] where GroupKey : Hashable Groups up elements of self into a new Dictionary, whose values are Arrays of grouped elements, each keyed by the group key returned by the given closure.
func indexed() -> IndexedCollection<Self> Returns a collection of pairs (i, x), where i represents an index of the collection, and x represents an element.
func interspersed(with separator: Element) -> InterspersedSequence<Self> Returns a sequence containing elements of this sequence with the given separator inserted in between each element.
func keyed<Key>(by keyForValue: (Element) throws -> Key) rethrows -> [Key : Element] where Key : Hashable Creates a new Dictionary from the elements of self, keyed by the results returned by the given keyForValue closure.
func keyed<Key>(by keyForValue: (Element) throws -> Key, resolvingConflictsWith resolve: (Key, Element, Element) throws -> Element) rethrows -> [Key : Element] where Key : Hashable Creates a new Dictionary from the elements of self, keyed by the results returned by the given keyForValue closure. As the dictionary is built, the initializer calls the resolve closure with the current and new values for any duplicate keys. Pass a closure as resolve that returns the value to use in the resulting dictionary: The closure can choose between the two values, combine them to produce a new value, or even throw an error.
func max(count: Int) -> [Element] Returns the largest elements of this collection.
func max(count: Int, sortedBy areInIncreasingOrder: (Element, Element) throws -> Bool) rethrows -> [Element] Returns the largest elements of this collection, as sorted by the given predicate.
func min(count: Int) -> [Element] Returns the smallest elements of this collection.
func min(count: Int, sortedBy areInIncreasingOrder: (Element, Element) throws -> Bool) rethrows -> [Element] Returns the smallest elements of this collection, as sorted by the given predicate.
func minAndMax() -> (min: Element, max: Element)? Returns both the minimum and maximum elements in the sequence.
func minAndMax(by areInIncreasingOrder: (Element, Element) throws -> Bool) rethrows -> (min: Element, max: Element)? Returns both the minimum and maximum elements in the sequence, using the given predicate as the comparison between elements.
func partitioned(by predicate: (Element) throws -> Bool) rethrows -> (falseElements: [Element], trueElements: [Element]) Returns two arrays containing, in order, the elements of the collection that do and don’t satisfy the given predicate.
func partitioningIndex(where belongsInSecondPartition: (Element) throws -> Bool) rethrows -> Index Returns the start index of the partition of a collection that matches the given predicate.
func permutations(ofCount k: Int? = nil) -> PermutationsSequence<Self> Returns a collection of the permutations of this collection of the specified length.
func randomSample(count k: Int) -> [Element] Randomly selects the specified number of elements from this collection.
func randomSample<G>(count k: Int, using rng: inout G) -> [Element] where G : RandomNumberGenerator Randomly selects the specified number of elements from this sequence.
func randomSample<G>(count k: Int, using rng: inout G) -> [Element] where G : RandomNumberGenerator Randomly selects the specified number of elements from this collection.
func randomStableSample(count k: Int) -> [Element] Randomly selects the specified number of elements from this collection, maintaining their relative order.
func randomStableSample<G>(count k: Int, using rng: inout G) -> [Element] where G : RandomNumberGenerator Randomly selects the specified number of elements from this collection, maintaining their relative order.
func reductions(_ transform: (Element, Element) throws -> Element) rethrows -> [Element] Returns an array containing the accumulated results of combining the elements of the sequence using the given closure.
func reductions<Result>(_ initial: Result, _ transform: (Result, Element) throws -> Result) rethrows -> [Result] Returns an array containing the accumulated results of combining the elements of the sequence using the given closure.
func reductions<Result>(into initial: Result, _ transform: (inout Result, Element) throws -> Void) rethrows -> [Result] Returns an array containing the accumulated results of combining the elements of the sequence using the given closure.
func secureCompare<C>(to other: C) -> Bool where C : Collection, Self.Element == C.Element Performs a full-comparison of all elements in two collections. If the two collections have a different number of elements, the function will compare all elements in the smaller collection first and then return false.
func sequencedFlatMapEach(on eventLoop: EventLoop, _ transform: @escaping (_ element: Element) -> EventLoopFuture<Void>) -> EventLoopFuture<Void> An overload of sequencedFlatMapEach(on:_:) which returns a Void future instead of [Void] when the result type of the transform closure is Void.
func sequencedFlatMapEachCompact<Result>(on eventLoop: EventLoop, _ transform: @escaping (_ element: Element) -> EventLoopFuture<Result?>) -> EventLoopFuture<[Result]> Variant of sequencedFlatMapEach(on:_:) which provides compactMap() semantics by allowing result values to be nil. Such results are not included in the output array.
func startOfSuffix(while predicate: (Element) throws -> Bool) rethrows -> Index Returns the inclusive lower bound of the suffix of elements that satisfy the predicate.
func striding(by step: Int) -> StridingCollection<Self> Returns a sequence stepping through the elements every step starting at the first value. Any remainders of the stride will be trimmed.
func suffix(while predicate: (Element) throws -> Bool) rethrows -> SubSequence Returns a subsequence containing the elements from the end until predicate returns false and skipping the remaining elements.
mutating func trim(while predicate: (Element) throws -> Bool) rethrows Mutates a BidirectionalCollection by discarding all elements at the start and at the end of it which satisfy the given predicate.
mutating func trimPrefix(while predicate: (Element) throws -> Bool) rethrows Mutates a Collection by discarding all elements at the start of it which satisfy the given predicate.
mutating func trimSuffix(while predicate: (Element) throws -> Bool) rethrows Mutates a BidirectionalCollection by discarding all elements at the end of it which satisfy the given predicate.
func trimming(while predicate: (Element) throws -> Bool) rethrows -> SubSequence Returns a SubSequence formed by discarding all elements at the start and end of the collection which satisfy the given predicate.
func trimmingSuffix(while predicate: (Element) throws -> Bool) rethrows -> SubSequence Returns a SubSequence formed by discarding all elements at the end of the collection which satisfy the given predicate.
func uniquePermutations(ofCount k: Int? = nil) -> UniquePermutationsSequence<Self> Returns a sequence of the unique permutations of this sequence of the specified length.
func uniqued() -> UniquedSequence<Self, Element> Returns a sequence with only the unique elements of this sequence, in the order of the first occurrence of each unique element.
func uniqued<Subject>(on projection: (Element) throws -> Subject) rethrows -> [Element] where Subject : Hashable Returns an array with the unique elements of this sequence (as determined by the given projection), in the order of the first occurrence of each unique element.
func windows(ofCount count: Int) -> WindowsOfCountCollection<Self> Returns a collection of all the overlapping slices of a given size.
func scan(_ transform: (Element, Element) throws -> Element) rethrows -> [Element] func scan<Result>(_ initial: Result, _ transform: (Result, Element) throws -> Result) rethrows -> [Result] func scan<Result>(into initial: Result, _ transform: (inout Result, Element) throws -> Void) rethrows -> [Result]