NominalElementDictionary

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

A Dictionary with a nominal Element type, that can conform to things.

Show on GitHub

  • The underlying Swift dictionary.

    Declaration

    Swift

    public typealias Base = [Key : Value]
    Show on GitHub

  • A view of a dictionary’s keys.

    Declaration

    Swift

    public typealias Keys = Base.Keys
    Show on GitHub

  • A view of a dictionary’s values.

    Declaration

    Swift

    public typealias Values = Base.Values
    Show on GitHub

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

    Declaration

    Swift

    public typealias Index = Base.Index
    Show on GitHub

  • The underlying Swift Dictionary

    Declaration

    Swift

    public var base: Base
    Show on GitHub

  • Creates an instance equivalent to base.

    Declaration

    Swift

    public init(_ base: Base)
    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

  • Creates an empty dictionary.

    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.

    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.

    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.

    Declaration

    Swift

    public init<S>(
  grouping values: S, by keyForValue: (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 -> NominalElementDictionary
    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.

    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 -> NominalElementDictionary<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 -> [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(
  _ value: 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 combine: (Value, Value) throws -> Value
) rethrows where S : Sequence, S.Element == Element
    Show on GitHub

  • Merges the given dictionary into this dictionary, using a combining closure to determine the value for any duplicate keys.

    Declaration

    Swift

    public mutating func merge(
  _ other: Self,
  uniquingKeysWith combine: (Value, Value) throws -> Value
) rethrows
    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 the specified index.

    Declaration

    Swift

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

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

    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

  • A collection containing just the keys of the dictionary.

    Declaration

    Swift

    @available(swift 4.0)
public var keys: Keys { get }
    Show on GitHub

  • A collection containing just the values of the dictionary.

    Declaration

    Swift

    @available(swift 4.0)
public var values: Values { get set }
    Show on GitHub

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

    See more

    Declaration

    Swift

    public struct Iterator : IteratorProtocol
    Show on GitHub

  • Removes and returns the first key-value pair of the dictionary if the dictionary isn’t empty.

    Declaration

    Swift

    public mutating func popFirst() -> Element?
    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 position immediately after the given index.

    Declaration

    Swift

    public func index(after i: Index) -> Index
    Show on GitHub

  • Replaces the given index with its successor.

    Declaration

    Swift

    public func formIndex(after i: inout Index)
    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