Struct reference_trie::TrieDBMut

pub struct TrieDBMut<'a, L> where
    L: TrieLayout,  { /* fields omitted */ }

A Trie implementation using a generic HashDB backing database.

Use it as a TrieMut trait object. You can use db() to get the backing database object. Note that changes are not committed to the database until commit is called.

Querying the root or dropping the trie will commit automatically.

Example

use hash_db::Hasher;
use reference_trie::{RefTrieDBMut, TrieMut};
use trie_db::DBValue;
use keccak_hasher::KeccakHasher;
use memory_db::*;

let mut memdb = MemoryDB::<KeccakHasher, HashKey<_>, DBValue>::default();
let mut root = Default::default();
let mut t = RefTrieDBMut::new(&mut memdb, &mut root);
assert!(t.is_empty());
assert_eq!(*t.root(), KeccakHasher::hash(&[0u8][..]));
t.insert(b"foo", b"bar").unwrap();
assert!(t.contains(b"foo").unwrap());
assert_eq!(t.get(b"foo").unwrap().unwrap(), b"bar".to_vec());
t.remove(b"foo").unwrap();
assert!(!t.contains(b"foo").unwrap());

Methods

impl<'a, L> TrieDBMut<'a, L> where
    L: TrieLayout, 

pub fn new(
    db: &'a mut (dyn HashDB<<L as TrieLayout>::Hash, Vec<u8>> + 'a),
    root: &'a mut <<L as TrieLayout>::Hash as Hasher>::Out
) -> TrieDBMut<'a, L>

Create a new trie with backing database db and empty root.

pub fn from_existing(
    db: &'a mut (dyn HashDB<<L as TrieLayout>::Hash, Vec<u8>> + 'a),
    root: &'a mut <<L as TrieLayout>::Hash as Hasher>::Out
) -> Result<TrieDBMut<'a, L>, Box<TrieError<<<L as TrieLayout>::Hash as Hasher>::Out, <<L as TrieLayout>::Codec as NodeCodec>::Error>>>

Create a new trie with the backing database db and root. Returns an error if root` does not exist.

pub fn db(&self) -> &dyn HashDB<<L as TrieLayout>::Hash, Vec<u8>>

Get the backing database.

pub fn db_mut(&mut self) -> &mut dyn HashDB<<L as TrieLayout>::Hash, Vec<u8>>

Get the backing database mutably.

pub fn commit(&mut self)

Commit the in-memory changes to disk, freeing their storage and updating the state root.

Trait Implementations

impl<'a, L> Drop for TrieDBMut<'a, L> where
    L: TrieLayout, 

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, L> TrieMut<L> for TrieDBMut<'a, L> where
    L: TrieLayout, 

fn root(&mut self) -> &<<L as TrieLayout>::Hash as Hasher>::Out

Return the root of the trie.

fn is_empty(&self) -> bool

Is the trie empty?

fn get<'x, 'key>(
    &'x self,
    key: &'key [u8]
) -> Result<Option<Vec<u8>>, Box<TrieError<<<L as TrieLayout>::Hash as Hasher>::Out, <<L as TrieLayout>::Codec as NodeCodec>::Error>>> where
    'x: 'key, 

What is the value of the given key in this trie?

fn insert(
    &mut self,
    key: &[u8],
    value: &[u8]
) -> Result<Option<Vec<u8>>, Box<TrieError<<<L as TrieLayout>::Hash as Hasher>::Out, <<L as TrieLayout>::Codec as NodeCodec>::Error>>>

Insert a key/value pair into the trie. An empty value is equivalent to removing key from the trie. Returns the old value associated with this key, if it existed.

fn remove(
    &mut self,
    key: &[u8]
) -> Result<Option<Vec<u8>>, Box<TrieError<<<L as TrieLayout>::Hash as Hasher>::Out, <<L as TrieLayout>::Codec as NodeCodec>::Error>>>

Remove a key from the trie. Equivalent to making it equal to the empty value. Returns the old value associated with this key, if it existed.

fn contains(
    &self,
    key: &[u8]
) -> Result<bool, Box<TrieError<<<L as TrieLayout>::Hash as Hasher>::Out, <<L as TrieLayout>::Codec as NodeCodec>::Error>>>

Does the trie contain a given key?