Structure

IndexPath

iOS 8.0+ iPadOS 8.0+ Mac Catalyst 8.0+ macOS 10.10+ tvOS 9.0+ watchOS 2.0+

A list of indexes that together represent the path to a specific location in a tree of nested arrays.

struct IndexPath

Overview

Each index in an index path represents the index into an array of children from one node in the tree to another, deeper, node.

init()
Creates an empty index path.
init(arrayLiteral: IndexPath.Element...)
Creates an index path from an array literal.
init(index: IndexPath.Element)
Creates an index path with a single element.
init(indexes:)
Creates an index path from an array of elements.

var count: Int
var endIndex: IndexPath.Index
One past the index of the last node in the index path.
var startIndex: IndexPath.Index
The index of the first node in the index path.

func append(_:)
Appends an array of elements to this index path as additional nodes.
func appending(_:)
Returns a new index path containing the elements of this one plus an array of additional elements.
func compare(IndexPath) -> ComparisonResult
Compares this index path to another in depth-first traversal order.
func dropLast() -> IndexPath
Returns a new index path containing all but the last element.
func hash(into: inout Hasher)
func index(after: IndexPath.Index) -> IndexPath.Index
Returns the index that follows the given index.
func index(before: IndexPath.Index) -> IndexPath.Index
Returns the index that precedes the given index.
func makeIterator() -> IndexingIterator<IndexPath>
Returns an iterator over the nodes of the index path.

typealias Element
A type that represents one node of an index path.
typealias Index
A type that points to a particular node in an index path, similar to an array index.
typealias Indices
A type that represents a group of nodes in an index path.