aboutsummaryrefslogtreecommitdiffstats
path: root/docs/architecture.puml
blob: 87b462b69bff430daee002da9546081f28a202db (plain) (blame)
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
@startuml
!theme toy
title RNT Architecture
hide empty members
skinparam classAttributeIconSize 0
skinparam linetype ortho
skinparam nodesep 30
skinparam ranksep 50
skinparam defaultFontSize 15
left to right direction

class Condition <<module>> {
  .. types ..
  +condition
  +ps
  .. values ..
  +"|=|"
  +"&"
  +empty() : ps
  +condition() : condition
  +complement() : condition
  +to_string_hum() : string
}

class Configuration <<module>> {
  .. types ..
  +term
  +dictionary
  .. values ..
  +term_of_sexp() : term
  +tag_of() : string, Condition.condition result
  +value_for() : term, Condition.condition result
  +as_dictionary() : dictionary, Condition.condition result
  +as_int() : int, Condition.condition result
  +as_string() : string, Condition.condition result
}

class Cursor <<module>> {
  .. types ..
  +descriptor
  +cursor
  .. values ..
  +open_() : cursor, Concepts.Condition.condition result
  +next() : Concepts.Tuple.t option, Concepts.Condition.condition result
  +close() : unit
}

class FOL <<module>> {
  .. types ..
  +path_arg
  +t
  +stream
  +right
  .. values ..
  +singleton()
  +resolve()
}

class Handle <<module>> {
  .. types ..
  +t
  +handle
  +cursor
  .. values ..
  +open_() : handle, Concepts.Condition.condition result
  +open_cursor() : cursor, Concepts.Condition.condition result
  +next() : Concepts.Tuple.t option, Concepts.Condition.condition result
  +close() : unit
  +create() : t
  +object_() : Object.registry
}

class Hash <<module>> {
  .. types ..
  +hash
  .. values ..
  +hash_of_value() : hash
  +hash_equals() : bool
  +bytes_of_hash() : bytes
}

class Identity <<module>> {
  .. values ..
  +permits() : bool
  +can_open() : bool
  +can_close() : bool
}

class LMDB <<module>> {
}

class Lifecycle <<module>> {
  .. types ..
  +tree
  +disposal
  .. values ..
  +monitor() : tree
  +pin() : tree
  +unpin() : tree
  +is_eligible_for_gc() : bool
  +contention() : bool
  +unmonitor() : tree * disposal BatFingerTree.t, Concepts.Condition.condi...
  +collect() : tree * disposal BatFingerTree.t, Concepts.Condition.condi...
}

class Namespace <<module>> {
  .. types ..
  +tree
  .. values ..
  +resolve() : Concepts.Path.t, Concepts.Condition.condition result
}

class Object <<module>> {
  .. types ..
  +multigroup
  +relation
  +ephemeral_relation
  +transaction
  +session
  +branch
  +branch_tree
  +rnt_object_kind
  +namespace
  +rnt_method
  +rnt_object
  +registry
  +rnt_object_tree
  .. values ..
  +make_object()
  +root()
  +find()
  +update()
  +reference_edges()
  +adjust_references()
  +is_gc_exempt()
  +is_runtime()
  +has_children()
  +register()
  +with_namespace()
  +construct_multigroup()
  +construct_relation()
  +unregister()
}

class Path <<module>> {
  .. types ..
  +t
  .. values ..
  +empty() : t
  +of_list() : t
  +to_list() : string list
  +snoc() : t
  +to_string() : string
  +is_prefix() : bool
}

class Representation <<module>> {
  .. types ..
  +blob
  .. values ..
  +blob_of_value() : blob
  +value_of_blob() : Value.value
  +blob_of_bytes() : blob
  +bytes_of_blob() : bytes
}

class Storage <<module>> {
  .. types ..
  +connection
  +transaction
}

class Tuple <<module>> {
  .. types ..
  +t
  .. values ..
  +empty() : t
  +access() : Value.value option
  +merge() : t
  +project() : t
  +rename() : t
}

class Utilities <<module>> {
  .. values ..
  +"let*"
  +fmap() : 'b, 'e result
}

class Value <<module>> {
  .. types ..
  +value
  .. values ..
  +to_string() : string
  +equal() : bool
}

Condition --> Value
Configuration --> Condition
Cursor ..> Condition
Cursor ..> Path
Cursor *-- Storage
Cursor ..> Tuple
Cursor ..> Value
FOL ..> Condition
FOL ..> Path
FOL --> Tuple
FOL ..> Value
Handle --> Condition
Handle *-- Cursor
Handle --> Object
Handle ..> Path
Handle *-- Storage
Handle ..> Tuple
Handle ..> Value
Hash ..> Value
Identity ..> Object
LMDB ..> Condition
LMDB --> Configuration
LMDB --> Hash
LMDB --> Representation
LMDB ..> Storage
LMDB ..> Value
Lifecycle ..> Condition
Lifecycle --> Object
Lifecycle ..> Path
Namespace ..> Condition
Namespace ..> Object
Namespace ..> Path
Namespace *-- Storage
Object --> Condition
Object --> Path
Object ..> Value
Representation ..> Value
Storage ..> Condition
Storage ..> Configuration
Storage ..> Hash
Storage ..> Representation
Tuple ..> Value

legend right
  diamond A *-- B : functor composition (@composes)
  solid   A --> B : declared call (@uses)
  dashed  A ..> B : type-only coupling (@needs)
endlegend
@enduml