File: KeyValueStorage.swift

package info (click to toggle)
swiftlang 6.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,856,264 kB
  • sloc: cpp: 9,995,718; ansic: 2,234,019; asm: 1,092,167; python: 313,940; objc: 82,726; f90: 80,126; lisp: 38,373; pascal: 25,580; sh: 20,378; ml: 5,058; perl: 4,751; makefile: 4,725; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (38 lines) | stat: -rw-r--r-- 2,111 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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2025 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 the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import Foundation

/// Generic protocol representing operations common to dictionaries, caches, and other key-value stores.
public protocol KeyValueStorage<Key, Value> {
    associatedtype Key
    associatedtype Value

    func getOrInsert(_ key: Key, _ body: () throws -> Value) rethrows -> Value
}

extension KeyValueStorage {
    public func getOrInsert<Wrapped>(_ key: Key, body: () throws -> Wrapped) rethrows -> Wrapped where Value == Lazy<Wrapped> {
        return try getOrInsert(key, isValid: { _ in true }, body: body)
    }

    /// Gets or inserts a value into the key-value store using `Lazy` as its value type.
    ///
    /// This is used as a convenience wrapper which effectively implements a uses two-level lock: one to protect the key-value store itself, and one lock per value, so that values can be computed in parallel while maintaining the guarantee that `body` is called only once per key.
    ///
    /// - parameter key: The key used to identify the value in the key-value store.
    /// - parameter isValid: A closure used to indicate whether the existing stored value for `key` is still valid. Return `false` to discard the currently cached value and call `body` to compute a new value.
    /// - parameter body: A closure used to compute the value for `key`. Will be called at most once per key in case of race conditions.
    public func getOrInsert<Wrapped>(_ key: Key, isValid: (Wrapped) throws -> Bool, body: () throws -> Wrapped) rethrows -> Wrapped where Value == Lazy<Wrapped> {
        return try getOrInsert(key) { .init() }.getValue(body, isValid: isValid)
    }
}