A collection containing a single element.
SDK
Framework
@frozen struct CollectionOfOne<Element>
You can use a Collection instance when you need to efficiently represent a single value as a collection. For example, you can add a single element to an array by using a Collection instance with the concatenation operator (+):
let a = [1, 2, 3, 4]
let toAdd = 100
let b = a + CollectionOfOne(toAdd)
// b == [1, 2, 3, 4, 100]
typealias CollectionA sequence that represents a contiguous subrange of the collection’s elements.
typealias CollectionA type that represents a position in the collection.
typealias CollectionA type that represents the indices that are valid for subscripting the collection, in ascending order.
init(Element)Creates an instance containing just the given element.
var count: IntThe number of elements in the collection, which is always one.
var customThe custom mirror for this instance.
var debugA textual representation of the collection, suitable for debugging.
var endThe “past the end” position—that is, the position one greater than the last valid subscript argument.
var first: Element?The first element of the collection.
var indices: Range<Int>The indices that are valid for subscripting the collection, in ascending order.
var isA Boolean value indicating whether the collection is empty.
var last: Element?The last element of the collection.
var lazy: LazyA sequence containing the same elements as this sequence, but on which some operations, such as map and filter, are implemented lazily.
var startThe position of the first element.
var underestimatedA value less than or equal to the number of elements in the collection.
func allReturns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func compactReturns an array containing the non-nil results of calling the given transformation with each element of this sequence.
func contains(Element) -> BoolReturns a Boolean value indicating whether the sequence contains the given element.
func contains(where: (Element) -> Bool) -> BoolReturns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func difference<C>(from: C) -> CollectionReturns the difference needed to produce this collection’s ordered elements from the given collection.
func difference<C>(from: C, by: (CReturns the difference needed to produce this collection’s ordered elements from the given collection, using the given predicate as an equivalence test.
func distance(from: Int, to: Int) -> IntReturns the distance between two indices.
func drop(while: (Element) -> Bool) -> Slice<CollectionReturns a subsequence by skipping elements while predicate returns true and returning the remaining elements.
func dropReturns a subsequence containing all but the given number of initial elements.
func dropReturns a subsequence containing all but the specified number of final elements.
func elementsReturns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.
func elementsReturns 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() -> EnumeratedReturns 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((Element) -> Bool) -> [Element]Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.
func first(where: (Element) -> Bool) -> Element?Returns the first element of the sequence that satisfies the given predicate.
func firstReturns the first index where the specified value appears in the collection.
func firstReturns the first index in which an element of the collection satisfies the given predicate.
func flatReturns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func forCalls the given closure on each element in the sequence in the same order as a for-in loop.
func formOffsets the given index by the specified distance.
func formOffsets the given index by the specified distance, or so that it equals the given limiting index.
func formReplaces the given index with its successor.
func formReplaces the given index with its predecessor.
func index(Int, offsetReturns an index that is the specified distance from the given index.
func index(Int, offsetReturns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.
func index(after: CollectionReturns the position immediately after the given index.
func index(before: CollectionReturns the position immediately before the given index.
func index(of: Element) -> Int?Returns the first index where the specified value appears in the collection.
func index(where: (Element) -> Bool) -> Int?Returns the first index in which an element of the collection satisfies the given predicate.
func joined() -> FlattenReturns the elements of this sequence of sequences, concatenated.
func joined<Separator>(separator: Separator) -> JoinedReturns the concatenated elements of this sequence of sequences, inserting the given separator between each element.
func joined(separator: String) -> StringReturns a new string by concatenating the elements of the sequence, adding the given separator between each element.
func joined(separator: String) -> StringReturns a new string by concatenating the elements of the sequence, adding the given separator between each element.
func last(where: (Element) -> Bool) -> Element?Returns the last element of the sequence that satisfies the given predicate.
func lastReturns the last index where the specified value appears in the collection.
func lastReturns the index of the last element in the collection that matches the given predicate.
func lexicographicallyReturns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the less-than operator (<) to compare elements.
func lexicographicallyReturns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.
func makeReturns an iterator over the elements of this collection.
func map<T>((Element) -> T) -> [T]Returns an array containing the results of mapping the given closure over the sequence’s elements.
func max() -> Element?Returns the maximum element in the sequence.
func max(by: (Element, Element) -> Bool) -> Element?Returns the maximum element in the sequence, using the given predicate as the comparison between elements.
func min() -> Element?Returns the minimum element in the sequence.
func min(by: (Element, Element) -> Bool) -> Element?Returns the minimum element in the sequence, using the given predicate as the comparison between elements.
func partition(by: (Element) -> Bool) -> IntReorders the elements of the collection such that all the elements that match the given predicate are after all the elements that don’t match.
func prefix(Int) -> Slice<CollectionReturns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through: Int) -> Slice<CollectionReturns a subsequence from the start of the collection through the specified position.
func prefix(upReturns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while: (Element) -> Bool) -> Slice<CollectionReturns a subsequence containing the initial elements until predicate returns false and skipping the remaining elements.
func randomReturns a random element of the collection.
func randomReturns a random element of the collection, using the given generator as a source for randomness.
func reduce<Result>(Result, (Result, Element) -> Result) -> ResultReturns the result of combining the elements of the sequence using the given closure.
func reduce<Result>(into: Result, (inout Result, Element) -> ()) -> ResultReturns the result of combining the elements of the sequence using the given closure.
func reverse()Reverses the elements of the collection in place.
func reversed() -> ReversedReturns 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() -> [Element]Returns the elements of the sequence, shuffled.
func shuffled<T>(using: inout T) -> [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: (Element, Element) -> Bool)Sorts the collection in place, using the given predicate as the comparison between elements.
func sorted() -> [Element]Returns the elements of the sequence, sorted.
func sorted(by: (Element, Element) -> Bool) -> [Element]Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.
func split(maxReturns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.
func split(separator: Element, maxReturns the longest possible subsequences of the collection, in order, around elements equal to the given element.
func split(separator: Element, maxReturns the longest possible subsequences of the sequence, in order, around elements equal to the given element.
func starts<PossibleReturns a Boolean value indicating whether the initial elements of the sequence are the same as the elements in another sequence.
func starts<PossibleReturns 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) -> Slice<CollectionReturns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from: Int) -> Slice<CollectionReturns a subsequence from the specified position to the end of the collection.
func swapExchanges the values at the specified indices of the collection.
func withCall body(p), where p is a pointer to the collection’s mutable contiguous storage. If no such storage exists, it is first created. If the collection does not support an internal representation in a form of mutable contiguous storage, body is not called and nil is returned.
func withCall body(p), where p is a pointer to the collection’s contiguous storage. If no such storage exists, it is first created. If the collection does not support an internal representation in a form of contiguous storage, body is not called and nil is returned.
subscript(Int) -> ElementAccesses the element at the specified position.
subscript(Range<Int>) -> Slice<CollectionAccesses a contiguous subrange of the collection’s elements.
subscript<R>(R) -> Slice<CollectionAccesses the contiguous subrange of the collection’s elements specified by a range expression.
subscript(Range<Int>) -> CollectionAccesses a contiguous subrange of the collection’s elements.
struct CollectionAn iterator that produces one or zero instances of an element.
func repeatCreates a collection containing the specified number of the given element.
struct EmptyA collection whose element type is Element but that is always empty.
struct KeyA lightweight collection of key-value pairs.
typealias DictionaryDeprecated