File: FileSystemSignatureBasedCache.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 (51 lines) | stat: -rw-r--r-- 1,948 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
//===----------------------------------------------------------------------===//
//
// 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 SWBUtil

/// Provides a cache of objects keyed by a tuple of a path, and signature representing a hash of the contents at that path.
final class FileSystemSignatureBasedCache<Value: Sendable>: Sendable {
    private struct Key: Hashable, Sendable {
        let path: Path
        let filesSignature: FilesSignature
    }

    private let cache = Cache<Key, Lazy<Result<Value, any Error>>>()
    private let block: @Sendable (Path) throws -> Value

    /// Initializes a cache.
    /// - parameter block: A block which computes the object keyed by the given path. It is the caller's responsibility to access the actual filesystem.
    init(_ block: @escaping @Sendable (Path) throws -> Value) {
        self.block = block
    }

    /// Gets the object with the given path and signature, creating it if necessary.
    public func get(at path: Path, filesSignature: FilesSignature) throws -> Value {
        return try cache.getOrInsert(Key(path: path, filesSignature: filesSignature), body: { () -> Result<Value, any Error> in
            return Result<Value, any Error> {
                try block(path)
            }
        }).get()
    }
}

protocol FileSystemInitializable {
    init(path: Path, fs: any FSProxy) throws
}

extension FileSystemSignatureBasedCache where Value: FileSystemInitializable {
    convenience init(fs: any FSProxy) {
        self.init { path in
            try Value(path: path, fs: fs)
        }
    }
}