Structureswift 6.0.1Swift
Keys
A view of a dictionary’s keys.
@frozen struct KeysOther members in extension
View members
Hide members
This section is hidden by default because it contains too many (35) members.
Types
struct IndexThe position of a key-value pair in a dictionary.
struct IteratorAn iterator over the members of a
Dictionary<Key, Value>.struct ValuesA view of a dictionary’s values.
Typealiases
Type members
init(dictionaryLiteral: (Key, Value)...) Creates a dictionary initialized with a dictionary literal.
Instance members
var capacity: IntThe total number of key-value pairs that the dictionary can contain without allocating new storage.
var count: IntThe number of key-value pairs in the dictionary.
var customMirror: MirrorA mirror that reflects the dictionary.
var debugDescription: StringA string that represents the contents of the dictionary, suitable for debugging.
var description: StringA string that represents the contents of the dictionary.
var endIndex: Dictionary<Key, Value>.IndexThe dictionary’s “past the end” position—that is, the position one greater than the last valid subscript argument.
var isEmpty: BoolA Boolean value that indicates whether the dictionary is empty.
var keys: Dictionary<Key, Value>.KeysA collection containing just the keys of the dictionary.
var startIndex: Dictionary<Key, Value>.IndexThe position of the first element in a nonempty dictionary.
var values: Dictionary<Key, Value>.ValuesA collection containing just the values of the dictionary.
subscript(Key) -> Value? Accesses the value associated with the given key for reading and writing.
subscript(Dictionary<Key, Value>.Index) -> Dictionary<Key, Value>.Element Accesses the key-value pair at the specified position.
subscript(Key, default: @autoclosure () -> Value) -> Value Accesses the value with the given key, falling back to the given default value if the key isn’t found.
func compactMapValues<T>((Value) throws -> T?) rethrows -> Dictionary<Key, T> Returns a new dictionary containing only the key-value pairs that have non-
nilvalues as the result of transformation by the given closure.func filter((Dictionary<Key, Value>.Element) throws -> Bool) rethrows -> [Key : Value] Returns a new dictionary containing the key-value pairs of the dictionary that satisfy the given predicate.
func formIndex(after: inout Dictionary<Key, Value>.Index) func index(after: Dictionary<Key, Value>.Index) -> Dictionary<Key, Value>.Index func index(forKey: Key) -> Dictionary<Key, Value>.Index? Returns the index for the given key.
func makeIterator() -> Dictionary<Key, Value>.Iterator Returns an iterator over the dictionary’s key-value pairs.
func mapValues<T>((Value) throws -> T) rethrows -> Dictionary<Key, T> Returns a new dictionary containing the keys of this dictionary with the values transformed by the given closure.
func merge([Key : Value], uniquingKeysWith: (Value, Value) throws -> Value) rethrows Merges the given dictionary into this dictionary, using a combining closure to determine the value for any duplicate keys.
func merge<S>(S, uniquingKeysWith: (Value, Value) throws -> Value) rethrows Merges the key-value pairs in the given sequence into the dictionary, using a combining closure to determine the value for any duplicate keys.
func merging([Key : Value], uniquingKeysWith: (Value, Value) throws -> Value) rethrows -> [Key : Value] Creates a dictionary by merging the given dictionary into this dictionary, using a combining closure to determine the value for duplicate keys.
func merging<S>(S, uniquingKeysWith: (Value, Value) throws -> Value) rethrows -> [Key : Value] Creates a dictionary by merging key-value pairs in a sequence into the dictionary, using a combining closure to determine the value for duplicate keys.
func popFirst() -> Dictionary<Key, Value>.Element? Removes and returns the first key-value pair of the dictionary if the dictionary isn’t empty.
func remove(at: Dictionary<Key, Value>.Index) -> Dictionary<Key, Value>.Element Removes and returns the key-value pair at the specified index.
func removeAll(keepingCapacity: Bool) Removes all key-value pairs from the dictionary.
func removeValue(forKey: Key) -> Value? Removes the given key and its associated value from the dictionary.
func reserveCapacity(Int) Reserves enough space to store the specified number of key-value pairs.
func updateValue(Value, forKey: Key) -> Value? Updates the value stored in the dictionary for the given key, or adds a new key-value pair if the key does not exist.
Citizens in Swift
Conformances
protocol Collection<Element>A sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol EquatableA type that can be compared for value equality.
protocol Sequence<Element>A type that provides sequential, iterated access to its elements.
Types
Typealiases
Type members
Instance members
var count: IntThe number of keys in the dictionary.
var debugDescription: Stringvar description: Stringvar endIndex: Dictionary<Key, Value>.Indexvar isEmpty: Boolvar startIndex: Dictionary<Key, Value>.Indexsubscript(Dictionary<Key, Value>.Index) -> Dictionary<Key, Value>.Keys.Element func formIndex(after: inout Dictionary<Key, Value>.Index) func index(after: Dictionary<Key, Value>.Index) -> Dictionary<Key, Value>.Index func makeIterator() -> Dictionary<Key, Value>.Keys.Iterator
Type features
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.
Instance features
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 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 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 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 count<E>(where: (Self.Element)throws Returns the number of elements in the sequence that satisfy the given predicate.
func distance(from: Self.Index, to: Self.Index) -> Int Returns the distance between two indices.
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 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 index(Self.Index, offsetBy: Int) -> Self.Index Returns 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 indices(of: Self.Element) -> RangeSet<Self.Index> Returns the indices of all the elements that are equal to the given element.
func indices(where: (Self.Element) throws -> Bool) rethrows -> RangeSet<Self.Index> Returns the indices of all the elements that match the given predicate.
func joined() -> FlattenSequence<Self> Returns the elements of this sequence of sequences, concatenated.
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 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, E>((Self.Element)throws Returns an array containing the results of mapping the given closure over the sequence’s elements.
func map<T, E>((Self.Element)throws 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 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 removingSubranges(RangeSet<Self.Index>) -> DiscontiguousSlice<Self> Returns a collection of the elements in this collection that are not represented by the given range set.
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() -> [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) -> [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 withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<Self.Element>) throws -> R) rethrows -> R?
Show obsolete interfaces (2)
Hide obsolete interfaces
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
Conformances
Citizens in Swift
Conformances
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol Escapable
Extension in InternalCollectionsUtilities
Conformances
Show implementation details (1)
Hide implementation details
protocol _UniqueCollectionA Collection type that is guaranteed not to contain any duplicate elements.