Struct memory_db::MemoryDB

pub struct MemoryDB<H, KF, T, M = MemCounter<T>> where
    H: KeyHasher,
    KF: KeyFunction<H>,
    M: MemTracker<T>,  { /* fields omitted */ }

Reference-counted memory-based HashDB implementation.

Use new() to create a new database. Insert items with insert(), remove items with remove(), check for existence with contains() and lookup a hash to derive the data with get(). Clear with clear() and purge the portions of the data that have no references with purge().

If you're not using the MallocSizeOf implementation to track memory usage, set the M type parameter to NoopTracker.

Example

use hash_db::{Hasher, HashDB, EMPTY_PREFIX};
use keccak_hasher::KeccakHasher;
use memory_db::{MemoryDB, HashKey};
fn main() {
  let mut m = MemoryDB::<KeccakHasher, HashKey<_>, Vec<u8>>::default();
  let d = "Hello world!".as_bytes();

  let k = m.insert(EMPTY_PREFIX, d);
  assert!(m.contains(&k, EMPTY_PREFIX));
  assert_eq!(m.get(&k, EMPTY_PREFIX).unwrap(), d);

  m.insert(EMPTY_PREFIX, d);
  assert!(m.contains(&k, EMPTY_PREFIX));

  m.remove(&k, EMPTY_PREFIX);
  assert!(m.contains(&k, EMPTY_PREFIX));

  m.remove(&k, EMPTY_PREFIX);
  assert!(!m.contains(&k, EMPTY_PREFIX));

  m.remove(&k, EMPTY_PREFIX);
  assert!(!m.contains(&k, EMPTY_PREFIX));

  m.insert(EMPTY_PREFIX, d);
  assert!(!m.contains(&k, EMPTY_PREFIX));
  m.insert(EMPTY_PREFIX, d);
  assert!(m.contains(&k, EMPTY_PREFIX));
  assert_eq!(m.get(&k, EMPTY_PREFIX).unwrap(), d);

  m.remove(&k, EMPTY_PREFIX);
  assert!(!m.contains(&k, EMPTY_PREFIX));
}

Implementations

impl<H, KF, T, M> MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    T: Default,
    KF: KeyFunction<H>,
    M: MemTracker<T>, 

Create a new MemoryDB from a given null key/data

pub fn remove_and_purge(
    &mut self,
    key: &<H as KeyHasher>::Out,
    prefix: Prefix
) -> Option<T>

Remove an element and delete it from storage if reference count reaches zero. If the value was purged, return the old value.

impl<'a, H, KF, T, M> MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    T: From<&'a [u8]>,
    KF: KeyFunction<H>,
    M: MemTracker<T> + Default, 

pub fn from_null_node(null_key: &'a [u8], null_node_data: T) -> Self

Create a new MemoryDB from a given null key/data

pub fn new(data: &'a [u8]) -> Self

Create a new instance of Self.

pub fn default_with_root() -> (Self, H::Out)

Create a new default instance of Self and returns Self and the root hash.

pub fn clear(&mut self)

Clear all data from the database.

Examples

extern crate hash_db;
extern crate keccak_hasher;
extern crate memory_db;

use hash_db::{Hasher, HashDB, EMPTY_PREFIX};
use keccak_hasher::KeccakHasher;
use memory_db::{MemoryDB, HashKey};

fn main() {
  let mut m = MemoryDB::<KeccakHasher, HashKey<_>, Vec<u8>>::default();
  let hello_bytes = "Hello world!".as_bytes();
  let hash = m.insert(EMPTY_PREFIX, hello_bytes);
  assert!(m.contains(&hash, EMPTY_PREFIX));
  m.clear();
  assert!(!m.contains(&hash, EMPTY_PREFIX));
}

pub fn purge(&mut self)

Purge all zero-referenced data from the database.

pub fn drain(&mut self) -> HashMap<KF::Key, (T, i32)>

Return the internal key-value HashMap, clearing the current state.

pub fn raw(
    &self,
    key: &<H as KeyHasher>::Out,
    prefix: Prefix
) -> Option<(&T, i32)>

Grab the raw information associated with a key. Returns None if the key doesn't exist.

Even when Some is returned, the data is only guaranteed to be useful when the refs > 0.

pub fn consolidate(&mut self, other: Self)

Consolidate all the entries of other into self.

pub fn keys(&self) -> HashMap<KF::Key, i32>

Get the keys in the database together with number of underlying references.

Trait Implementations

impl<H, KF, T, M> AsHashDB<H, T> for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    T: Default + PartialEq<T> + for<'a> From<&'a [u8]> + Clone + Send + Sync,
    KF: KeyFunction<H> + Send + Sync,
    M: MemTracker<T> + Send + Sync, 

fn as_hash_db(&self) -> &dyn HashDB<H, T>

Perform upcast to HashDB for anything that derives from HashDB.

fn as_hash_db_mut(&mut self) -> &mut dyn HashDB<H, T>

Perform mutable upcast to HashDB for anything that derives from HashDB.

impl<H, KF, T, M> AsPlainDB<<H as Hasher>::Out, T> for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    T: Default + PartialEq<T> + for<'a> From<&'a [u8]> + Clone + Send + Sync,
    KF: KeyFunction<H> + Send + Sync,
    KF::Key: Borrow<[u8]> + for<'a> From<&'a [u8]>,
    M: MemTracker<T> + Send + Sync, 

fn as_plain_db(&self) -> &dyn PlainDB<H::Out, T>

Perform upcast to PlainDB for anything that derives from PlainDB.

fn as_plain_db_mut(&mut self) -> &mut dyn PlainDB<H::Out, T>

Perform mutable upcast to PlainDB for anything that derives from PlainDB.

impl<H, KF, T, M> Clone for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    KF: KeyFunction<H>,
    T: Clone,
    M: MemTracker<T> + Copy, 

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, H, KF, T, M> Default for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    T: From<&'a [u8]>,
    KF: KeyFunction<H>,
    M: MemTracker<T> + Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<H, KF, T, M> Eq for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    KF: KeyFunction<H>,
    <KF as KeyFunction<H>>::Key: Eq + MaybeDebug,
    T: Eq + MaybeDebug,
    M: MemTracker<T> + Eq, 

impl<H, KF, T, M> HashDB<H, T> for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    T: Default + PartialEq<T> + for<'a> From<&'a [u8]> + Clone + Send + Sync,
    KF: Send + Sync + KeyFunction<H>,
    M: MemTracker<T> + Send + Sync, 

fn get(&self, key: &H::Out, prefix: Prefix) -> Option<T>

Look up a given hash into the bytes that hash to it, returning None if the hash is not known.

fn contains(&self, key: &H::Out, prefix: Prefix) -> bool

Check for the existance of a hash-key.

fn emplace(&mut self, key: H::Out, prefix: Prefix, value: T)

Like insert(), except you provide the key and the data is all moved.

fn insert(&mut self, prefix: Prefix, value: &[u8]) -> H::Out

Insert a datum item into the DB and return the datum's hash for a later lookup. Insertions are counted and the equivalent number of remove()s must be performed before the data is considered dead.

fn remove(&mut self, key: &H::Out, prefix: Prefix)

Remove a datum previously inserted. Insertions can be "owed" such that the same number of insert()s may happen without the data being eventually being inserted into the DB. It can be "owed" more than once.

impl<H, KF, T, M> HashDBRef<H, T> for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    T: Default + PartialEq<T> + for<'a> From<&'a [u8]> + Clone + Send + Sync,
    KF: KeyFunction<H> + Send + Sync,
    M: MemTracker<T> + Send + Sync, 

fn get(&self, key: &H::Out, prefix: Prefix) -> Option<T>

Look up a given hash into the bytes that hash to it, returning None if the hash is not known.

fn contains(&self, key: &H::Out, prefix: Prefix) -> bool

Check for the existance of a hash-key.

impl<H, KF, T, M> MallocSizeOf for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    H::Out: MallocSizeOf,
    T: MallocSizeOf,
    KF: KeyFunction<H>,
    KF::Key: MallocSizeOf,
    M: MemTracker<T>, 

fn size_of(&self, ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself. If T::size_of is a constant, consider implementing constant_size as well.

fn constant_size() -> Option<usize>

Used to optimize MallocSizeOf implementation for collections like Vec and HashMap to avoid iterating over them unnecessarily. The Self: Sized bound is for object safety.

impl<H, KF, T, M> PartialEq<MemoryDB<H, KF, T, M>> for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    KF: KeyFunction<H>,
    <KF as KeyFunction<H>>::Key: Eq + MaybeDebug,
    T: Eq + MaybeDebug,
    M: MemTracker<T> + PartialEq, 

fn eq(&self, other: &MemoryDB<H, KF, T, M>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<H, KF, T, M> PlainDB<<H as Hasher>::Out, T> for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    T: Default + PartialEq<T> + for<'a> From<&'a [u8]> + Clone + Send + Sync,
    KF: Send + Sync + KeyFunction<H>,
    KF::Key: Borrow<[u8]> + for<'a> From<&'a [u8]>,
    M: MemTracker<T> + Send + Sync, 

fn get(&self, key: &H::Out) -> Option<T>

Look up a given hash into the bytes that hash to it, returning None if the hash is not known.

fn contains(&self, key: &H::Out) -> bool

Check for the existance of a hash-key.

fn emplace(&mut self, key: H::Out, value: T)

Insert a datum item into the DB. Insertions are counted and the equivalent number of remove()s must be performed before the data is considered dead. The caller should ensure that a key only corresponds to one value.

fn remove(&mut self, key: &H::Out)

Remove a datum previously inserted. Insertions can be "owed" such that the same number of insert()s may happen without the data being eventually being inserted into the DB. It can be "owed" more than once. The caller should ensure that a key only corresponds to one value.

impl<H, KF, T, M> PlainDBRef<<H as Hasher>::Out, T> for MemoryDB<H, KF, T, M> where
    H: KeyHasher,
    T: Default + PartialEq<T> + for<'a> From<&'a [u8]> + Clone + Send + Sync,
    KF: Send + Sync + KeyFunction<H>,
    KF::Key: Borrow<[u8]> + for<'a> From<&'a [u8]>,
    M: MemTracker<T> + Send + Sync, 

fn get(&self, key: &H::Out) -> Option<T>

Look up a given hash into the bytes that hash to it, returning None if the hash is not known.

fn contains(&self, key: &H::Out) -> bool

Check for the existance of a hash-key.