StructureFoundation5.9.0
IndexPath
IndexPath represents the path to a specific node in a tree of nested array collections.
struct IndexPathEach index in an index path represents the index into an array of children from one node in the tree to another, deeper, node.
Citizens in Foundation
Conformances
protocol BidirectionalCollectionA collection that supports backward as well as forward traversal.
protocol CollectionA sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol ComparableA type that can be compared using the relational operators
<,<=,>=, and>.protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol CustomReflectableA type that explicitly supplies its own mirror.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol DecodableA type that can decode itself from an external representation.
protocol EncodableA type that can encode itself to an external representation.
protocol EquatableA type that can be compared for value equality.
protocol ExpressibleByArrayLiteralA type that can be initialized using an array literal.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol MutableCollectionA collection that supports subscript assignment.
protocol RandomAccessCollectionA collection that supports efficient random-access index traversal.
protocol ReferenceConvertibleDecorates types which are backed by a Foundation reference type.
protocol SequenceA type that provides sequential, iterated access to its elements.
Members
init() Initialize an empty index path.
init(arrayLiteral: IndexPath.Element...) Initialize with an array literal.
init(from: Decoder) throws init(index: IndexPath.Element) Initialize with a single element.
init(indexes: Array<IndexPath.Element>) Initialize with an array of elements.
init<ElementSequence>(indexes: ElementSequence) Initialize with a sequence of integers.
var count: Intvar customMirror: Mirrorvar debugDescription: Stringvar description: Stringvar endIndex: IndexPath.Indexvar startIndex: IndexPath.Indexsubscript(Range<IndexPath.Index>) -> IndexPath subscript(IndexPath.Index) -> IndexPath.Element static func + (IndexPath, IndexPath) -> IndexPath static func += (inout IndexPath, IndexPath) static func < (IndexPath, IndexPath) -> Bool static func <= (IndexPath, IndexPath) -> Bool static func == (IndexPath, IndexPath) -> Bool static func > (IndexPath, IndexPath) -> Bool static func >= (IndexPath, IndexPath) -> Bool func append(IndexPath) Append an
IndexPathtoself.func append(Array<IndexPath.Element>) Append an array of elements to
self.func append(IndexPath.Element) Append a single element to
self.func appending(IndexPath) -> IndexPath Return a new
IndexPathcontaining the elements in self and the elements inother.func appending(Array<IndexPath.Element>) -> IndexPath Return a new
IndexPathcontaining the elements in self and the elements inother.func appending(IndexPath.Element) -> IndexPath Return a new
IndexPathcontaining the elements in self and the elements inother.func compare(IndexPath) -> ComparisonResult Sorting an array of
IndexPathusing this comparison results in an array representing nodes in depth-first traversal order.func dropLast() -> IndexPath Return a new
IndexPathcontaining all but the last element.func encode(to: Encoder) throws func hash(into: inout Hasher) func index(after: IndexPath.Index) -> IndexPath.Index func index(before: IndexPath.Index) -> IndexPath.Index func makeIterator() -> IndexingIterator<IndexPath> typealias Elementtypealias Indextypealias Indicestypealias ReferenceType
Features
var first: Self.Element?The first element of the collection.
var halfWidthCornerQuoted: Stringvar 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.static func != (Self, Self) -> Bool static func ... (Self) -> PartialRangeFrom<Self> Returns a partial range extending upward from a lower bound.
static func ... (Self) -> PartialRangeThrough<Self> Returns a partial range up to, and including, its upper bound.
static func ... (Self, Self) -> ClosedRange<Self> Returns a closed range that contains both of its bounds.
static func ..< (Self) -> PartialRangeUpTo<Self> Returns a partial range up to, but not including, its upper bound.
static func ..< (Self, Self) -> Range<Self> Returns a half-open range that contains its lower bound but not its upper bound.
func all((Self.Element) -> Bool) -> Bool func allSatisfy((Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func any((Self.Element) -> Bool) -> Bool 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 convertByOffset<C>(Self.Index, in: C) -> C.Index func convertByOffset<C>(Range<Self.Index>, in: C) -> Range<C.Index> 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.Element] Returns an array containing, in order, the elements of the sequence 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 firstRange<C>(of: C) -> Range<Self.Index>? Finds and returns the range of the first occurrence of a given collection within this collection.
func firstRange<C>(of: C) -> Range<Self.Index>? Finds and returns the range of the first occurrence of a given collection within this collection.
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 flatmapOffsets(Offsets?) -> Range<Self.Index> 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 index(atOffset: Int) -> Self.Index 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 map<T>((Self.Element) throws -> T) rethrows -> [T] Returns an array containing the results of mapping the given closure over the sequence’s elements.
func map<T>((Self.Element) throws -> T) rethrows -> [T] Returns an array containing the results of mapping the given closure over the sequence’s elements.
func mapOffsets(Offsets) -> Range<Self.Index> 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 none((Self.Element) -> Bool) -> Bool func offset(of: Self.Index) -> Int func offset(ofIndex: Self.Index) -> Int func offsets(of: Range<Self.Index>) -> Range<Int> 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 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 ranges<C>(of: C) -> [Range<Self.Index>] Finds and returns the ranges of the all occurrences of a given sequence within the collection.
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 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 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 reverse() Reverses the elements of the collection in place.
func reversed() -> ReversedCollection<Self> Returns a view presenting the elements of the collection in reverse order.
func shuffle() Shuffles the collection in place.
func shuffle<T>(using: inout T) Shuffles the collection in place, using the given generator as a source for randomness.
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 sort() Sorts the collection in place.
func sort(by: (Self.Element, Self.Element) throws -> Bool) rethrows Sorts the collection in place, using the given predicate as the comparison between elements.
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(around: Range<Self.Index>) -> (prefix: Self.SubSequence, Self.SubSequence, suffix: Self.SubSequence) 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 trimPrefix<Prefix>(Prefix) Removes the initial elements that satisfy the given predicate from the start of the sequence.
func trimPrefix(while: (Self.Element) throws -> Bool) throws func trimmingPrefix<Prefix>(Prefix) -> Self.SubSequence Returns a new collection of the same type by removing initial elements that satisfy the given predicate from the start.
func trimmingPrefix(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence func tryDropPrefix<C>(C) -> Self.SubSequence? Attempts to drop a given prefix from the collection.
func tryDropSuffix<C>(C) -> Self.SubSequence? Attempts to drop a given suffix from the collection.
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.