bitcoin-index 0.1.16-alpha.0

abstractions for working with indices of blockchain data
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

crate::ix!();

pub trait GetDB {
    fn getdb(&self) -> &mut BaseIndexDB;
}

/// The database stores a block locator of the chain the database is synced to so that the index
/// can efficiently determine the point it last stopped at.
/// 
/// A locator is used instead of a simple hash of the chain tip because blocks and block index
/// entries may not be flushed to disk until after this database is updated.
/// 
pub struct BaseIndexDB {
    base: DBWrapper,
}

impl BaseIndexDB {

    pub fn new(
        path:         &Path,
        n_cache_size: usize,
        memory:       Option<bool>,
        wipe:         Option<bool>,
        obfuscate:    Option<bool>) -> Self {

        let memory:    bool = memory.unwrap_or(false);
        let wipe:      bool = wipe.unwrap_or(false);
        let obfuscate: bool = obfuscate.unwrap_or(false);
    
        todo!();
        /*
        : cdb_wrapper(path, n_cache_size, f_memory, f_wipe, f_obfuscate),
        */
    }
    
    /**
      | Read block locator of the chain that
      | the txindex is in sync with.
      |
      */
    pub fn read_best_block(&self, locator: &mut BlockLocator) -> bool {
        
        todo!();

        /*
        let success: bool = read(DB_BEST_BLOCK,locator);

        if !success {
            locator.set_null();
        }

        success
        */
    }
    
    /**
      | Write block locator of the chain that
      | the txindex is in sync with.
      |
      */
    pub fn write_best_block(&mut self, 
        batch:   &mut DBBatch,
        locator: &BlockLocator)  {
        
        todo!();

        /*
        batch.write(DB_BEST_BLOCK, locator);
        */
    }
}