StructureSwift
CollectionDifference
A collection of insertions and removals that describe the difference between two ordered collection states.
- iOS 13.0+
- macOS 10.15+
- tvOS 13.0+
- watchOS 6.0+
struct CollectionDifference<ChangeElement>Members
Typealiases
typealias ElementA type representing the sequence’s elements.
Initializers
init?<Changes>(Changes)Creates a new collection difference from a collection of changes.
init(from: Decoder) throwsCreates a new instance by decoding from the given decoder.
Instance Subscripts
subscript(Range<Self.Index>) -> Slice<Self>Accesses a contiguous subrange of the collection’s elements.
subscript((UnboundedRange_) -> ()) -> Self.SubSequencesubscript<R>(R) -> Self.SubSequenceAccesses the contiguous subrange of the collection’s elements specified by a range expression.
subscript(CollectionDifference<ChangeElement>.Index) -> CollectionDifference<ChangeElement>.ElementAccesses the element at the specified position.
Instance Properties
var count: IntThe number of elements in the collection.
var first: Self.Element?The first element of the collection.
var indices: DefaultIndices<Self>The indices that are valid for subscripting the collection, in ascending order.
var isEmpty: BoolA Boolean value indicating whether the collection is empty.
var underestimatedCount: IntA value less than or equal to the number of elements in the collection.
var endIndex: CollectionDifference<ChangeElement>.IndexThe collection’s “past the end” position—that is, the position one greater than the last valid subscript argument.
let insertions: [CollectionDifference<ChangeElement>.Change]The insertions contained by this difference, from lowest offset to highest.
let removals: [CollectionDifference<ChangeElement>.Change]The removals contained by this difference, from lowest offset to highest.
var startIndex: CollectionDifference<ChangeElement>.IndexThe position of the first element in a nonempty 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 sequence, calculated nondestructively.
Instance Methods
func drop(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequenceReturns a subsequence by skipping elements while
predicatereturnstrueand returning the remaining elements.func dropFirst(Int) -> Self.SubSequenceReturns a subsequence containing all but the given number of initial elements.
func dropLast(Int) -> Self.SubSequenceReturns a subsequence containing all but the specified number of final elements.
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 formIndex(inout Self.Index, offsetBy: Int, limitedBy: Self.Index) -> BoolOffsets the given index by the specified distance, or so that it equals the given limiting index.
func formIndex(after: inout Self.Index)Replaces the given index with its successor.
func index(Self.Index, offsetBy: Int) -> Self.IndexReturns an index that is the specified distance from the given index.
func index(Self.Index, offsetBy: Int, limitedBy: Self.Index) -> Self.Index?Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.
func makeIterator() -> IndexingIterator<Self>Returns an iterator over the elements of the collection.
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 prefix(Int) -> Self.SubSequenceReturns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through: Self.Index) -> Self.SubSequenceReturns a subsequence from the start of the collection through the specified position.
func prefix(upTo: Self.Index) -> Self.SubSequenceReturns 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.SubSequenceReturns 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 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 suffix(Int) -> Self.SubSequenceReturns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from: Self.Index) -> Self.SubSequenceReturns a subsequence from the specified position to the end of the collection.
func distance(from: CollectionDifference<ChangeElement>.Index, to: CollectionDifference<ChangeElement>.Index) -> IntReturns the distance between two indices.
func formIndex(inout CollectionDifference<ChangeElement>.Index, offsetBy: Int)func index(after: CollectionDifference<ChangeElement>.Index) -> CollectionDifference<ChangeElement>.IndexReturns the position immediately after the given index.
func index(before: CollectionDifference<ChangeElement>.Index) -> CollectionDifference<ChangeElement>.Indexfunc inferringMoves() -> CollectionDifference<ChangeElement>Returns a new collection difference with associations between individual elements that have been removed and inserted only once.
func inverse() -> CollectionDifference<ChangeElement>func allSatisfy((Self.Element) throws -> Bool) rethrows -> BoolReturns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
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) -> BoolReturns a Boolean value indicating whether the sequence contains the given element.
func contains(where: (Self.Element) throws -> Bool) rethrows -> BoolReturns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func elementsEqual<OtherSequence>(OtherSequence) -> BoolReturns 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 -> BoolReturns 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 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) rethrowsCalls the given closure on each element in the sequence in the same order as a
for-inloop.func lexicographicallyPrecedes<OtherSequence>(OtherSequence, by: (Self.Element, Self.Element) throws -> Bool) rethrows -> BoolReturns 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 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(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 reduce<Result>(Result, (Result, Self.Element) throws -> Result) rethrows -> ResultReturns the result of combining the elements of the sequence using the given closure.
func reduce<Result>(into: Result, (inout Result, Self.Element) throws -> ()) rethrows -> ResultReturns the result of combining the elements of the sequence using the given closure.
func reversed() -> [Self.Element]Returns an array containing the elements of this sequence 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(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(separator: Self.Element, maxSplits: Int, omittingEmptySubsequences: Bool) -> [ArraySlice<Self.Element>]Returns the longest possible subsequences of the sequence, in order, around elements equal to the given element.
func starts<PossiblePrefix>(with: PossiblePrefix) -> BoolReturns 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 -> BoolReturns 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 withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<Self.Element>) throws -> R) rethrows -> R?Executes a closure on the sequence’s contiguous storage.
Operators
Enumerations
enum ChangeA single change to a collection.
Structures
struct IndexThe position of a collection difference.
Conforms To
CollectionDecodableWhen
ChangeElementconforms toDecodableandChangeElementconforms toEncodableEncodableWhen
ChangeElementconforms toDecodableandChangeElementconforms toEncodableEquatableWhen
ChangeElementconforms toEquatableHashableWhen
ChangeElementconforms toHashableSendableWhen
ChangeElementconforms toSendableSequence
Removed Members
Instance Methods
func index(of: Self.Element) -> Self.Index?Returns the first index where the specified value appears in the collection.
Deprecated since Swift 5.0
func flatMap<ElementOfResult>((Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult]Deprecated since Swift 4.1