StructureSwift5.9.0
ContiguousArray
A contiguously stored array.
@frozen struct ContiguousArray<Element>The ContiguousArray type is a specialized array that always stores its elements in a contiguous region of memory. This contrasts with Array, which can store its elements in either a contiguous region of memory or an NSArray instance if its Element type is a class or @objc protocol.
If your array’s Element type is a class or @objc protocol and you do not need to bridge the array to NSArray or pass the array to Objective-C APIs, using ContiguousArray may be more efficient and have more predictable performance than Array. If the array’s Element type is a struct or enumeration, Array and ContiguousArray should have similar efficiency.
For more information about using arrays, see Array and ArraySlice, with which ContiguousArray shares most properties and methods.
Citizens in Swift
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 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 ExpressibleByArrayLiteralA type that can be initialized using an array literal.
protocol MutableCollectionA collection that supports subscript assignment.
protocol RandomAccessCollectionA collection that supports efficient random-access index traversal.
protocol RangeReplaceableCollectionA collection that supports replacement of an arbitrary subrange of elements with the elements of another collection.
protocol SequenceA type that provides sequential, iterated access to its elements.
Members
init() Creates a new, empty array.
init<S>(S) Creates an array containing the elements of a sequence.
init(arrayLiteral: Element...) Creates an array from the given array literal.
init(repeating: Element, count: Int) Creates a new array containing the specified number of a single, repeated value.
init(unsafeUninitializedCapacity: Int, initializingWith: (inout UnsafeMutableBufferPointer<Element>, inout Int) throws -> Void) rethrows Creates an array with the specified capacity, then calls the given closure with a buffer covering the array’s uninitialized memory.
var capacity: IntThe total number of elements that the array can contain without allocating new storage.
var count: IntThe number of elements in the array.
var customMirror: MirrorA mirror that reflects the array.
var debugDescription: StringA textual representation of the array and its elements, suitable for debugging.
var description: StringA textual representation of the array and its elements.
var endIndex: IntThe array’s “past the end” position—that is, the position one greater than the last valid subscript argument.
var startIndex: IntThe position of the first element in a nonempty array.
subscript(Range<Int>) -> ArraySlice<Element> Accesses a contiguous subrange of the array’s elements.
subscript(Int) -> Element Accesses the element at the specified position.
func append(Element) Adds a new element at the end of the array.
func append<S>(contentsOf: S) Adds the elements of a sequence to the end of the array.
func distance(from: Int, to: Int) -> Int Returns the distance between two indices.
func formIndex(after: inout Int) Replaces the given index with its successor.
func formIndex(before: inout Int) Replaces the given index with its predecessor.
func index(Int, offsetBy: Int) -> Int Returns an index that is the specified distance from the given index.
func index(Int, offsetBy: Int, limitedBy: Int) -> Int? Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.
func index(after: Int) -> Int Returns the position immediately after the given index.
func index(before: Int) -> Int Returns the position immediately before the given index.
func insert(Element, at: Int) Inserts a new element at the specified position.
func remove(at: Int) -> Element Removes and returns the element at the specified position.
func removeAll(keepingCapacity: Bool) Removes all elements from the array.
func replaceSubrange<C>(Range<Int>, with: C) Replaces a range of elements with the elements in the specified collection.
func reserveCapacity(Int) Reserves enough space to store the specified number of elements.
func withContiguousMutableStorageIfAvailable<R>((inout UnsafeMutableBufferPointer<Element>) throws -> R) rethrows -> R? func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<Element>) throws -> R) rethrows -> R? func withUnsafeBufferPointer<R>((UnsafeBufferPointer<Element>) throws -> R) rethrows -> R Calls a closure with a pointer to the array’s contiguous storage.
func withUnsafeBytes<R>((UnsafeRawBufferPointer) throws -> R) rethrows -> R Calls the given closure with a pointer to the underlying bytes of the array’s contiguous storage.
func withUnsafeMutableBufferPointer<R>((inout UnsafeMutableBufferPointer<Element>) throws -> R) rethrows -> R Calls the given closure with a pointer to the array’s mutable contiguous storage.
func withUnsafeMutableBytes<R>((UnsafeMutableRawBufferPointer) throws -> R) rethrows -> R Calls the given closure with a pointer to the underlying bytes of the array’s mutable contiguous storage.
typealias IndexThe index type for arrays,
Int.typealias IndicesThe type that represents the indices that are valid for subscripting an array, in ascending order.
typealias IteratorThe type that allows iteration over an array’s elements.
Features
var first: Self.Element?The first element of the collection.
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.static func + <Other>(Other, Self) -> Self Creates a new collection by concatenating the elements of a sequence and a collection.
static func + <Other>(Self, Other) -> Self Creates a new collection by concatenating the elements of a collection and a sequence.
static func + <Other>(Self, Other) -> Self Creates a new collection by concatenating the elements of two collections.
static func += <Other>(inout Self, Other) Appends the elements of a sequence to a range-replaceable collection.
func allSatisfy((Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
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 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 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 joined() -> FlattenSequence<Self> Returns the elements of this sequence of sequences, concatenated.
func joined(separator: String) -> String Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.
func joined<Separator>(separator: Separator) -> JoinedSequence<Self> Returns the concatenated elements of this sequence of sequences, inserting the given separator between each element.
func joined(separator: String) -> String Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.
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 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 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 removeLast() -> Self.Element Removes and returns the last element of the collection.
func removeLast(Int) Removes the specified 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(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) -> [ArraySlice<Self.Element>] Returns the longest possible subsequences of the sequence, in order, around elements equal to the given element.
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 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.
Citizens in Swift
where Element:EquatableConformances
protocol EquatableA type that can be compared for value equality.
Members
static func == (ContiguousArray<Element>, ContiguousArray<Element>) -> Bool Returns a Boolean value indicating whether two arrays contain the same elements in the same order.
Features
Citizens in Swift
where Element:DecodableConformances
protocol DecodableA type that can decode itself from an external representation.
Members
init(from: Decoder) throws Creates a new contiguous array by decoding from the given decoder.
Citizens in Swift
where Element:EncodableConformances
protocol EncodableA type that can encode itself to an external representation.
Members
func encode(to: Encoder) throws Encodes the elements of this contiguous array into the given encoder in an unkeyed container.
Citizens in Swift
where Element:HashableConformances
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.
Members
func hash(into: inout Hasher) Hashes the essential components of this value by feeding them into the given hasher.
Citizens in Swift
where Element:SendableConformances
protocol SendableA type whose values can safely be passed across concurrency domains by copying.
Available in Foundation
where Element == UInt8Conformances
protocol ContiguousBytesIndicates that the conforming type is a contiguous collection of raw bytes whose underlying storage is directly accessible by withUnsafeBytes.
protocol DataProtocolprotocol MutableDataProtocol