bitcoin-coinsview 0.1.16-alpha.0

abstractions for facilitating access to the UTXO set
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

crate::ix!();

/**
  | A convenience class for constructing
  | the CCoinsView* hierarchy used to facilitate
  | access to the UTXO set.
  | 
  | This class consists of an arrangement
  | of layered CCoinsView objects, preferring
  | to store and retrieve coins in memory
  | via `m_cacheview` but ultimately falling
  | back on cache misses to the canonical
  | store of UTXOs on disk, `m_dbview`.
  |
  */
//TODO: #[GUARDED_BY(cs_main)]
pub struct CoinsViews {

    /**
      | The lowest level of the CoinsViews cache
      | hierarchy sits in a leveldb database on
      | disk.
      |
      | All unspent coins reside in this store.
      */
    dbview:      CoinsViewDB,

    /**
      | This view wraps access to the leveldb
      | instance and handles read errors
      | gracefully.
      |
      */
    catcherview: CoinsViewErrorCatcher,

    /**
      | This is the top layer of the cache hierarchy
      | - it keeps as many coins in memory as can
      | fit per the dbcache setting.
      |
      */
    cacheview:   Box<CoinsViewCache>,
}

impl CoinsViews {
    
    /**
      | This constructor initializes CCoinsViewDB
      | and CCoinsViewErrorCatcher instances, but
      | it *does not* create a CCoinsViewCache
      | instance by default. This is done
      | separately because the presence of the
      | cache has implications on whether or not
      | we're allowed to flush the cache's state
      | to disk, which should not be done until
      | the health of the database is verified.
      |
      | All arguments forwarded onto CCoinsViewDB.
      */
    pub fn new(
        ldb_name:         String,
        cache_size_bytes: usize,
        in_memory:        bool,
        should_wipe:      bool) -> Self {
    
        todo!();
        /*
           : m_dbview(
           gArgs.GetDataDirNet() / ldb_name, cache_size_bytes, in_memory, should_wipe),
           m_catcherview(&m_dbview)
           */
    }
    
    /**
      | Initialize the CCoinsViewCache member.
      |
      */
    #[EXCLUSIVE_LOCKS_REQUIRED(::cs_main)]
    pub fn init_cache(&mut self)  {
        
        todo!();
        /*
            m_cacheview = std::make_unique<CCoinsViewCache>(&m_catcherview);
        */
    }
}