InsertionOrderedDictionary

public struct InsertionOrderedDictionary<Key, Value> where Key : Hashable
extension InsertionOrderedDictionary : RandomAccessCollection
extension InsertionOrderedDictionary : Sequence
extension InsertionOrderedDictionary : CustomReflectable
extension InsertionOrderedDictionary
  : CustomStringConvertible, CustomDebugStringConvertible
extension InsertionOrderedDictionary : Hashable where Value : Hashable
extension InsertionOrderedDictionary : Equatable where Value : Equatable
extension InsertionOrderedDictionary
  : Decodable where Key : Decodable, Value : Decodable
extension InsertionOrderedDictionary : Encodable
  where Key : Encodable, Value : Encodable

A Dictionary with a deterministic sequence traversal order determined by the order in which keys are added.

Show on GitHub

  • The elements of self.

    Declaration

    Swift

    public private(set) var elements: [KeyValuePair<Key, Value>]
    Show on GitHub

  • A mapping from keys to indices in elements.

    Declaration

    Swift

    public private(set) var indexForKey: [Key : Int]
    Show on GitHub

  • The element type of a dictionary, just like a tuple containing an individual key-value pair, but nominal.

    Declaration

    Swift

    public typealias Element = KeyValuePair<Key, Value>
    Show on GitHub

  • The position of a key-value pair in a dictionary.

    Declaration

    Swift

    public typealias Index = Keys.Index
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public typealias Keys = Projections<[Element], Element.ProjectKey>
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public var keys: Keys { get }
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public typealias Values = Projections<[Element], Element.ProjectValue>
    Show on GitHub

  • Undocumented

    Declaration

    Swift

    public var values: Values { get set }
    Show on GitHub

  • Creates an instance equivalent to source.

    Declaration

    Swift

    public init(_ source: [Key : Value])
    Show on GitHub

  • Creates an empty instance.

    Declaration

    Swift

    public init()
    Show on GitHub

  • Creates an empty dictionary with preallocated space for at least the specified number of elements.

    Declaration

    Swift

    public init(minimumCapacity: Int)
    Show on GitHub

  • Creates a new dictionary from the key-value pairs in the given sequence.

    The keys in the result are ordered in the same order as in uniqueKeysWithValues.

    Declaration

    Swift

    public init<S>(
  uniqueKeysWithValues keysAndValues: S)
  where S : Sequence, S.Element == Element
    Show on GitHub

  • Creates a new dictionary from the key-value pairs in the given sequence, using a combining closure to determine the value for any duplicate keys.

    The keys in the result are ordered according to their first appearance in keysAndValues.

    Declaration

    Swift

    public init<S>(
  _ keysAndValues: S,
  uniquingKeysWith combine: (Value, Value) throws -> Value
) rethrows where S : Sequence, S.Element == Element
    Show on GitHub

  • Creates a new dictionary whose keys are the groupings returned by the given closure and whose values are arrays of the elements that returned each key.

    The keys in the result are ordered according to their first appearance in source.

    Declaration

    Swift

    public init<S>(
  grouping source: S, by keyForSourceElement: (S.Element) throws -> Key)
  rethrows where Value == [S.Element], S : Sequence
    Show on GitHub

  • Returns a new dictionary containing the key-value pairs of the dictionary that satisfy the given predicate.

    Declaration

    Swift

    @available(swift 4.0)
public func filter(
  _ isIncluded: (Element) throws -> Bool
) rethrows -> InsertionOrderedDictionary
    Show on GitHub

  • Accesses the value associated with the given key, producing nil when the value of a key not in the dictionary is read, and erasing the key if nil is written.

    Complexity

    amortized O(1) unless a key is deleted, in which case O(count).

    Declaration

    Swift

    public subscript(key: Key) -> Value? { get set }
    Show on GitHub

  • Accesses the value for key, or defaultValue no such key exists in the dictionary, on write first inserting key with value defaultValue if it does not exist in the dictionary.

    Declaration

    Swift

    public subscript(
  key: Key, default defaultValue: @autoclosure () -> Value
) -> Value
    Show on GitHub

  • Returns a new dictionary containing the keys of this dictionary with the values transformed by the given closure.

    Declaration

    Swift

    public func mapValues<T>(
  _ transform: (Value) throws -> T
) rethrows -> InsertionOrderedDictionary<Key, T>
    Show on GitHub

  • Returns a new dictionary containing only the key-value pairs that have non-nil values as the result of transformation by the given closure.

    Declaration

    Swift

    public func compactMapValues<T>(
  _ transform: (Value) throws -> T?
) rethrows -> InsertionOrderedDictionary<Key, T>
    Show on GitHub

  • Updates the value stored in the dictionary for the given key and returns the old value, or adds a new key-value pair if the key does not exist and returns nil .

    Declaration

    Swift

    public mutating func updateValue(
  _ newValue: Value, forKey key: Key
) -> Value?
    Show on GitHub

  • Merges the key-value pairs in the given sequence into the dictionary, using a combining closure to determine the value for any duplicate keys.

    Declaration

    Swift

    public mutating func merge<S>(
  _ other: S,
  uniquingKeysWith combiner: (Value, Value) throws -> Value
) rethrows where S : Sequence, S.Element == Element
    Show on GitHub

  • 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.

    Declaration

    Swift

    public func merging<S>(
  _ other: S, uniquingKeysWith combine: (Value, Value) throws -> Value
) rethrows -> Self where S : Sequence, S.Element == Element
    Show on GitHub

  • Creates a dictionary by merging the given dictionary into this dictionary, using a combining closure to determine the value for duplicate keys.

    Declaration

    Swift

    public func merging(
  _ other: Self, uniquingKeysWith combine: (Value, Value) throws -> Value
) rethrows -> Self
    Show on GitHub

  • Removes and returns the key-value pair at i.

    Complexity

    O(count).

    Declaration

    Swift

    public mutating func remove(at i: Index) -> Element
    Show on GitHub

  • Removes the given key and its associated value from the dictionary.

    Complexity

    O(count)

    Declaration

    Swift

    public mutating func removeValue(forKey key: Key) -> Value?
    Show on GitHub

  • Removes all key-value pairs from the dictionary.

    Declaration

    Swift

    public mutating func removeAll(
  keepingCapacity keepCapacity: Bool = false
)
    Show on GitHub

  • An iterator over the members of a InsertionOrderedDictionary<Key, Value>.

    Declaration

    Swift

    public typealias Iterator = Array<Element>.Iterator
    Show on GitHub

  • The total number of key-value pairs that the dictionary can contain without allocating new storage.

    Declaration

    Swift

    public var capacity: Int { get }
    Show on GitHub

  • Reserves enough space to store the specified number of key-value pairs.

    Declaration

    Swift

    public mutating func reserveCapacity(_ minimumCapacity: Int)
    Show on GitHub

  • The position of the first element in a nonempty dictionary.

    Declaration

    Swift

    public var startIndex: Index { get }
    Show on GitHub

  • The dictionary’s “past the end” position—that is, the position one greater than the last valid subscript argument.

    Declaration

    Swift

    public var endIndex: Index { get }
    Show on GitHub

  • Returns the index for the given key.

    Declaration

    Swift

    public func index(forKey key: Key) -> Index?
    Show on GitHub

  • Accesses the key-value pair at the specified position.

    Declaration

    Swift

    public subscript(position: Index) -> Element { get }
    Show on GitHub

  • The number of key-value pairs in the dictionary.

    Declaration

    Swift

    public var count: Int { get }
    Show on GitHub

  • A Boolean value that indicates whether the dictionary is empty.

    Declaration

    Swift

    public var isEmpty: Bool { get }
    Show on GitHub

  • Returns an iterator over the dictionary’s key-value pairs.

    Declaration

    Swift

    public func makeIterator() -> Iterator
    Show on GitHub

  • A mirror that reflects the dictionary.

    Declaration

    Swift

    public var customMirror: Mirror { get }
    Show on GitHub

  • A string that represents the contents of the dictionary.

    Declaration

    Swift

    public var description: String { get }
    Show on GitHub

  • A string that represents the contents of the dictionary, suitable for debugging.

    Declaration

    Swift

    public var debugDescription: String { get }
    Show on GitHub

Available where Key : Decodable, Value : Decodable

  • Creates a new dictionary by decoding from the given decoder.

    Declaration

    Swift

    public init(from decoder: Decoder) throws
    Show on GitHub

Available where Key : Encodable, Value : Encodable

  • Encodes the contents of this dictionary into the given encoder.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws
    Show on GitHub