File: LMDB.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 (133 lines) | stat: -rw-r--r-- 4,449 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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/*
 This source file is part of the Swift.org open source project

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

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

import Foundation
import CLMDB

/**
    A general utility class for LMDB.
 
    - Note: LMDB wrapper doesn't use any writing queue to serialize writes, but it relies on LMDB's low level solution.
            Reads are never blocked, but writes are serialized using a mutually exclusive lock at the database level.
 */
final class LMDB {
    #if os(Windows)
    public typealias ModeType = CInt
    #else
    public typealias ModeType = mode_t
    #endif
        
    /// Default instance.
    public static var `default` = LMDB()
    
    /// Returns the library version.
    public var version: Version {
        return [Int(MDB_VERSION_MAJOR), Int(MDB_VERSION_MINOR), Int(MDB_VERSION_PATCH)]
    }
    
    /// The default number of databases to open which is `0`. The `0` value means no named databases can be opened.
    public static let defaultMaxDBs: UInt32 = 0
    
    /// The default number of readers to open which is `126`.
    public static let defaultMaxReaders: UInt32 = 126
    
    /// The default number of map size which is `10485760`.
    public static let defaultMapSize: size_t = 10485760
    
    /// The default file mode for opening an environment which is `744`.
    #if os(Windows)
    public static let defaultFileMode: ModeType = _S_IREAD | _S_IWRITE
    #else
    public static let defaultFileMode: ModeType = S_IRWXU | S_IRGRP | S_IROTH
    #endif
    
}

/**
 A type with a customized data representation suited for storage inside an LMDB database.

 Types that conform to the `LMDBData` protocol can provide their own representation to be used when converting 
 an instance to a valid data representation ready for LMDB storage.

 > Note: Default implementations for some common Swift types are included. Custom types require an appropriate 
 implementation of the conversion.
 */
public protocol LMDBData {
    init?(data: UnsafeRawBufferPointer)
    func read<ResultType>(_ body: (UnsafeRawBufferPointer) throws -> ResultType) rethrows -> ResultType
}

public extension LMDBData {
    init?(data: UnsafeRawBufferPointer) {
        guard data.count == MemoryLayout<Self>.stride else { return nil }
        self = data.baseAddress!.assumingMemoryBound(to: Self.self).pointee
    }
    
    func read<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R {
        var val = self
        return try withUnsafeBytes(of: &val, body)
    }
}

extension Data: LMDBData {
    public init?(data: UnsafeRawBufferPointer) {
        self = Data.init(bytes: data.baseAddress!, count: data.count)
    }

    public func read<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R{
        return try self.withUnsafeBytes({ (ptr) -> R in
            return try body(ptr)
        })
    }
}

extension String: LMDBData {
    public init?(data: UnsafeRawBufferPointer) {
        self.init(bytes: data, encoding: .utf8)
    }

    public func read<ResultType>(_ body: (UnsafeRawBufferPointer) throws -> ResultType) rethrows -> ResultType {
        return try self.data(using: .utf8)!.read(body)
    }
}

// This is required for macOS, for Linux the default implementation works as expected.
extension Array: LMDBData where Element: FixedWidthInteger {
    
#if os(macOS) || os(iOS) || os(tvOS) || os(watchOS)
    public init?(data: UnsafeRawBufferPointer) {
        var array = [Element](repeating: 0, count: data.count / MemoryLayout<Element>.stride)
        _ = array.withUnsafeMutableBytes { data.copyBytes(to: $0) }
        self = array
    }
    
    public func read<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R {
        let data = self.withUnsafeBufferPointer { Data(buffer: $0) }
        return try data.read(body)
    }
#endif

}

extension Bool: LMDBData {}
extension Int: LMDBData {}
extension Int8: LMDBData {}
extension Int16: LMDBData {}
extension Int32: LMDBData {}
extension Int64: LMDBData {}
extension UInt: LMDBData {}
extension UInt8: LMDBData {}
extension UInt16: LMDBData {}
extension UInt32: LMDBData {}
extension UInt64: LMDBData {}
extension Float: LMDBData {}
extension Double: LMDBData {}
extension Date: LMDBData {}
extension URL: LMDBData {}