pak-db 0.2.2

A read-only database format designed for speed, ease of use and data sharing.
Documentation
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
use std::{cmp::Ordering, collections::{HashMap, VecDeque}, fmt::Debug};
use ordermap::OrderSet;
use serde::{Deserialize, Serialize};

use crate::{builder::PakBuilder, error::{PakError, PakResult}, pointer::{PakPointer, PakUntypedPointer}};

use super::{value::PakValue, Pak};


//==============================================================================================
//        PakTree
//==============================================================================================

pub struct PakTree<'p> {
    pak : &'p Pak,
    meta : PakTreeMeta,
}

impl <'p> PakTree<'p> {
    pub fn new(pak: &'p Pak, key : &str) -> PakResult<PakTree<'p>> {
        let indices = pak.fetch_indices()?;
        let Some(pointer) = indices.get(key) else { return Err(PakError::InvalidIndex(key.to_string())) };
        let meta : PakTreeMeta = pak.read_err::<PakTreeMeta>(&pointer.as_pointer())?;
        
        Ok(PakTree {
            pak,
            meta,
        })
    }
    
    pub fn get(&self, value : &PakValue) -> PakResult<OrderSet<PakPointer>> {
        let pointer = self.meta.pages.get(&0).unwrap();
        let mut set = OrderSet::new();
        self.get_r(value, *pointer, &mut set)?;
        Ok(set)
    }
    
    fn get_r(&self, value : &PakValue, current_page : PakUntypedPointer, set : &mut OrderSet<PakPointer>) -> PakResult<()> {
        let page : PakTreePage = self.pak.read_err::<PakTreePage>(&current_page.as_pointer())?;
        
        for entry in page.values {
            if &entry.key < value {
                continue;
            } else if &entry.key > value {
                if let Some(index) = entry.previous {
                    let pointer = self.meta.pages.get(&index).unwrap();
                    self.get_r(value, *pointer, set)?;
                    return Ok(());
                }
            } else {
                entry.values.clone().into_iter().for_each(|value| {set.insert(value);});
                return Ok(());
            }
        }
        
        if let Some(index) = page.next {
            let pointer = self.meta.pages.get(&index).unwrap();
            self.get_r(value, *pointer, set)?;
        }
        
        Ok(())
    }
    
    pub fn get_less(&self, value : &PakValue) -> PakResult<OrderSet<PakPointer>> {
        let pointer = self.meta.pages.get(&0).unwrap();
        let mut results = OrderSet::new();
        self.get_less_r(value, *pointer, &mut results, false)?;
        Ok(results)
    }
    
    pub fn get_less_eq(&self, value : &PakValue) -> PakResult<OrderSet<PakPointer>> {
        let pointer = self.meta.pages.get(&0).unwrap();
        let mut results = OrderSet::new();
        self.get_less_r(value, *pointer, &mut results, true)?;
        Ok(results)
    }
    
    fn get_less_r(&self, value : &PakValue, current_page : PakUntypedPointer, set : &mut OrderSet<PakPointer>, match_eq : bool) -> PakResult<()> {
        let page = self.pak.read_err::<PakTreePage>(&current_page.as_pointer())?;
        
        for entry in page.values {
            if &entry.key > value {
                continue;
            } else if &entry.key < value {
                entry.values.clone().into_iter().for_each(|value| {set.insert(value);});
                if let Some(index) = entry.previous {
                    let pointer = self.meta.pages.get(&index).unwrap();
                    self.get_less_r(value, *pointer, set, match_eq)?;
                }
                continue;
            } else {
                if match_eq {
                    entry.values.clone().into_iter().for_each(|value| {set.insert(value);});
                }
                continue;
            }
        }
        
        if let Some(index) = page.next {
            let pointer = self.meta.pages.get(&index).unwrap();
            return self.get_less_r(value, *pointer, set, match_eq);
        }
        
        Ok(())
    }
    
    pub fn get_greater(&self, value : &PakValue) -> PakResult<OrderSet<PakPointer>> {
        let pointer = self.meta.pages.get(&0).unwrap();
        let mut results = OrderSet::new();
        self.get_greater_r(value, *pointer, &mut results, false)?;
        Ok(results)
    }
    
    pub fn get_greater_eq(&self, value : &PakValue) -> PakResult<OrderSet<PakPointer>> {
        let pointer = self.meta.pages.get(&0).unwrap();
        let mut results = OrderSet::new();
        self.get_greater_r(value, *pointer, &mut results, true)?;
        Ok(results)
    }
    
    fn get_greater_r(&self, value : &PakValue, current_page : PakUntypedPointer, set : &mut OrderSet<PakPointer>, match_eq : bool) -> PakResult<()> {
        let page : PakTreePage = self.pak.read_err::<PakTreePage>(&current_page.as_pointer())?;
        
        for entry in page.values {
            if &entry.key < value {
                continue;
            } else if &entry.key > value {
                entry.values.clone().into_iter().for_each(|value| {set.insert(value);});
                if let Some(index) = entry.previous {
                    let pointer = self.meta.pages.get(&index).unwrap();
                    self.get_greater_r(value, *pointer, set, match_eq)?;
                }
                continue;
            } else {
                if match_eq {
                    entry.values.clone().into_iter().for_each(|value| {set.insert(value);});
                }
                continue;
            }
        }
        
        if let Some(index) = page.next {
            let pointer = self.meta.pages.get(&index).unwrap();
            return self.get_greater_r(value, *pointer, set, match_eq);
        }
        
        Ok(())
    }
    
    pub fn get_contains(&self, value : &PakValue) -> PakResult<OrderSet<PakPointer>> {
        let pointer = self.meta.pages.get(&0).unwrap();
        let mut results = OrderSet::new();
        self.get_contains_r(value, *pointer, &mut results)?;
        Ok(results)
    }
    
    fn get_contains_r(&self, value : &PakValue, current_page : PakUntypedPointer, set : &mut OrderSet<PakPointer>) -> PakResult<()> {
        let page : PakTreePage = self.pak.read_err::<PakTreePage>(&current_page.as_pointer())?;
        for entry in page.values {
            if entry.key.contains(value) {
                entry.values.clone().into_iter().for_each(|value| {set.insert(value);});
            }
            if let Some(index) = entry.previous {
                let pointer = self.meta.pages.get(&index).unwrap();
                self.get_contains_r(value, *pointer, set)?;
            }
        }
        
        Ok(())
    }
}

//==============================================================================================
//        PakTreeMeta
//==============================================================================================

#[derive(Deserialize, Serialize, Debug)]
pub struct PakTreeMeta {
    pages: HashMap<usize, PakUntypedPointer>,
}

//==============================================================================================
//        PakTreeBuilder
//==============================================================================================

/// This is a pretty limited b-tree implementation. Since the end product is a read only datastructure, deletion is not supported. This
/// has been optimized for read performance and memory efficiency.
#[derive(Debug)]
pub struct PakTreeBuilder {
    pages : Vec<PakTreePage>,
    max_size: usize,
}

impl PakTreeBuilder {
    pub fn new(power_of_two: u32) -> Self {
        PakTreeBuilder {
            pages: vec![PakTreePage::new()],
            max_size : 2usize.pow(power_of_two),
        }
    }
    
    pub fn access<'t>(&'t mut self) -> PakTreeBuilderAccess<'t> {
        PakTreeBuilderAccess {
            current: 0,
            table: self,
            trail : VecDeque::new()
        }
    }
    
    pub fn into_pak(self, pak : &mut PakBuilder) -> PakResult<PakPointer> {
        let mut page_map = HashMap::<usize, PakUntypedPointer>::new();
        for (index, page) in self.pages.into_iter().enumerate() {
            let pointer = pak.pak_no_search(&page)?;
            page_map.insert(index as usize, pointer.as_untyped());
        }
        
        pak.pak_no_search(&PakTreeMeta{ pages : page_map})
    } 
}

//==============================================================================================
//        PakTreeAccess
//==============================================================================================

pub struct PakTreeBuilderAccess<'t> {
    table: &'t mut PakTreeBuilder,
    current: usize,
    trail : VecDeque<usize>
}

impl PakTreeBuilderAccess<'_> {    
    // fn root(&mut self) -> &mut Self {
    //     self.current = self.table.root;
    //     self
    // }
    
    fn goto(&mut self, page: usize) -> &mut Self {
        self.trail.push_front(self.current);
        self.current = page;
        self
    }
    
    fn back(&mut self) -> &mut Self {
        let front = self.trail.pop_front();
        if let Some(index) = front {
            self.current = index;
        }
        self
    }
    
    fn current(&self) -> &PakTreePage {
        &self.table.pages[self.current]
    }
    
    fn current_mut(&mut self) -> &mut PakTreePage {
        &mut self.table.pages[self.current]
    }
    
    fn push(&mut self, entry : PakTreePageEntry) -> PakTreeStatus{
        self.current_mut().push(entry)
    }
    
    fn insert_entry(&mut self, entry : PakTreePageEntry) -> usize {
        let mut result = self.push(entry);
        while let PakTreeStatus::Next(index, entry) = result {
            self.goto(index);
            result = self.push(entry);
        }
        
        let index = match result {
            PakTreeStatus::Ok(index) => index,
            PakTreeStatus::Next(_, _) => 0,
        };
        
        if self.current().values.len() > self.table.max_size {
            self.split();
        }
        
        index
    }
    
    pub fn insert<K>(&mut self, key: K, value: PakPointer) -> &mut Self where K: Into<PakValue> {
        self.insert_entry(PakTreePageEntry::new(key.into(), value));
        self
    }
    
    fn split(&mut self) {
        let mut leading_entries = VecDeque::new();
        let mut trailing_entries = VecDeque::new();
        
        let half_max = self.table.max_size / 2;
        
        for _ in 0..half_max {
            let current = self.current_mut();
            leading_entries.push_back(current.values.pop_front().unwrap());
            trailing_entries.push_front(current.values.pop_back().unwrap());
        }
        
        let mut middle_entry = self.current_mut().values.pop_front().unwrap();
        self.current_mut().values = trailing_entries;
        let leading_index = self.new_page(leading_entries);
        middle_entry.previous = Some(leading_index);
        
        self.back();
        
        self.insert_entry(middle_entry);
    }
    
    fn new_page(&mut self, values : VecDeque<PakTreePageEntry>) -> usize {
        let index = self.table.pages.len();
        self.table.pages.push(PakTreePage::new_with_entries(values));
        index
    }
}

//==============================================================================================
//        PakTreePage
//==============================================================================================

#[derive(Debug, Deserialize, Serialize)]
struct PakTreePage {
    values: VecDeque<PakTreePageEntry>,
    next: Option<usize>,
}

impl PakTreePage {
    fn new() -> Self {
        PakTreePage {
            values: VecDeque::new(),
            next: None,
        }
    }
    
    fn new_with_entries(entries: VecDeque<PakTreePageEntry>) -> Self {
        PakTreePage {
            values: entries,
            next: None,
        }
    }
    
    fn push(&mut self, mut e : PakTreePageEntry) -> PakTreeStatus {
        for (index, entry) in self.values.iter_mut().enumerate() {
            match entry.key.cmp(&e.key) {
                Ordering::Less => continue,
                Ordering::Greater => match entry.previous {
                        Some(next) => return PakTreeStatus::Next(next, e),
                        None => {
                            self.values.insert(index, e);
                            return PakTreeStatus::Ok(index);
                        },
                    },
                Ordering::Equal => {
                    entry.values.append(&mut e.values);
                    return PakTreeStatus::Ok(index);
                },
            }
        }
        match self.next {
            Some(index) => PakTreeStatus::Next(index, e),
            None => {
                self.values.push_back(e);
                return PakTreeStatus::Ok(self.values.len() - 1);
            },
        }
    }
}

enum PakTreeStatus {
    Ok(usize),
    Next(usize, PakTreePageEntry),
}

//==============================================================================================
//        PakTreePageEntry
//==============================================================================================

#[derive(Serialize, Deserialize)]
pub struct PakTreePageEntry {
    key: PakValue,
    values: Vec<PakPointer>,
    previous: Option<usize>,
}

impl Debug for PakTreePageEntry {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.key.fmt(f)?;
        if let Some(previous) = self.previous {
            f.write_str(" -> ")?;
            write!(f, "{}", previous)?;
        }
        Ok(())
    }
}

impl PakTreePageEntry {
    pub fn new(key: PakValue, value: PakPointer) -> Self {
        PakTreePageEntry {
            key,
            values : vec![value],
            previous: None,
        }
    }
}

impl PartialEq for PakTreePageEntry {
    fn eq(&self, other: &Self) -> bool {
        self.key.eq(&other.key)
    }
}

impl Eq for PakTreePageEntry {}

impl PartialOrd for PakTreePageEntry {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        self.key.partial_cmp(&other.key)
    }
}

impl Ord for PakTreePageEntry {
    fn cmp(&self, other: &Self) -> Ordering {
        self.key.cmp(&other.key)
    }
}