File: KeyedPair.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (54 lines) | stat: -rw-r--r-- 1,733 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/*
 This source file is part of the Swift.org open source project

 Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
 Licensed under Apache License v2.0 with Runtime Library Exception

 See http://swift.org/LICENSE.txt for license information
 See http://swift.org/CONTRIBUTORS.txt for Swift project authors
*/

/// Wrapper for exposing an item indexed by some other key type.
///
/// This is intended to be used when an algorithm wants to temporarily expose
/// some object as hashable based on a derived property (most commonly some
/// member of the object itself), without erasing the underlying object.
///
/// Example:
///
///     struct Airport {
///         // The name of the airport.
///         let name: String
///         // The names of destination airports for outgoing flights.
///         let destinations: [String]
///     }
///
///     func whereCanIGo(from here: Airport) -> [Airport] {
///         let closure = transitiveClosure([KeyedPair(airport, key: airport.name]) {
///             return $0.destinations.map({ KeyedPair($0, key: $0.name) })
///         }
///         return closure.map({ $0.item })
///     }
public struct KeyedPair<T, K: Hashable>: Hashable {
    /// The wrapped item.
    public let item: T

    /// The exposed key.
    public let key: K

    /// Create a new hashable pair for `item` indexed by `key`.
    public init(_ item: T, key: K) {
        self.item = item
        self.key = key
    }

    public func hash(into hasher: inout Hasher) {
        hasher.combine(key)
    }

    public static func ==(lhs: KeyedPair<T, K>, rhs: KeyedPair<T, K>) -> Bool {
        return lhs.key == rhs.key
    }
}

extension KeyedPair: Sendable where T: Sendable, K: Sendable {}