Struct trie_db::triedb::TrieDB

pub struct TrieDB<'db, 'cache, L>
where
    L: TrieLayout,
{ /* private fields */ }

A Trie implementation using a generic HashDB backing database, a Hasher implementation to generate keys and a NodeCodec implementation to encode/decode the nodes.

Use it as a Trie trait object. You can use db() to get the backing database object. Use get and contains to query values associated with keys in the trie.

Example

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

let mut memdb = MemoryDB::<KeccakHasher, HashKey<_>, _>::default();
let mut root = Default::default();
RefTrieDBMut::new(&mut memdb, &mut root).insert(b"foo", b"bar").unwrap();
let t = RefTrieDB::new(&memdb, &root);
assert!(t.contains(b"foo").unwrap());
assert_eq!(t.get(b"foo").unwrap().unwrap(), b"bar".to_vec());

Implementations

impl<'db, 'cache, L> TrieDB<'db, 'cache, L>

where L: TrieLayout,

pub fn db(&'db self) -> &'db dyn HashDBRef<L::Hash, DBValue>

Get the backing database.

pub fn into_double_ended_iter( &'db self ) -> Result<TrieDBDoubleEndedIterator<'db, 'cache, L>, TrieHash<L>, CError<L>>

Create TrieDBDoubleEndedIterator from TrieDB.

pub fn into_node_double_ended_iter( &'db self ) -> Result<TrieDBNodeDoubleEndedIterator<'db, 'cache, L>, TrieHash<L>, CError<L>>

Create TrieDBNodeDoubleEndedIterator from TrieDB.

pub fn into_key_double_ended_iter( &'db self ) -> Result<TrieDBKeyDoubleEndedIterator<'db, 'cache, L>, TrieHash<L>, CError<L>>

create TrieDBKeyDoubleEndedIterator from TrieDB.

pub fn into_fat_double_ended_iter( &'db self ) -> Result<FatDBDoubleEndedIterator<'db, 'cache, L>, TrieHash<L>, CError<L>>

create FatDBDoubleEndedIterator from TrieDB.

Trait Implementations

impl<'db, 'cache, L> Debug for TrieDB<'db, 'cache, L>

where L: TrieLayout,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'db, 'cache, L> Trie<L> for TrieDB<'db, 'cache, L>

where L: TrieLayout,

fn root(&self) -> &TrieHash<L>

Return the root of the trie.

fn get_hash( &self, key: &[u8] ) -> Result<Option<TrieHash<L>>, TrieHash<L>, CError<L>>

Returns the hash of the value for key.

fn get_with<Q: Query<L::Hash>>( &self, key: &[u8], query: Q ) -> Result<Option<Q::Item>, TrieHash<L>, CError<L>>

Search for the key with the given query parameter. See the docs of the Query trait for more details.

fn lookup_first_descendant( &self, key: &[u8] ) -> Result<Option<MerkleValue<TrieHash<L>>>, TrieHash<L>, CError<L>>

Look up the MerkleValue of the node that is the closest descendant for the provided key.

fn iter<'a>( &'a self ) -> Result<Box<dyn TrieIterator<L, Item = TrieItem<TrieHash<L>, CError<L>>> + 'a>, TrieHash<L>, CError<L>>

Returns a depth-first iterator over the elements of trie.

fn key_iter<'a>( &'a self ) -> Result<Box<dyn TrieIterator<L, Item = TrieKeyItem<TrieHash<L>, CError<L>>> + 'a>, TrieHash<L>, CError<L>>

Returns a depth-first iterator over the keys of elemets of trie.

fn is_empty(&self) -> bool

Is the trie empty?

fn contains(&self, key: &[u8]) -> Result<bool, TrieHash<L>, CError<L>>

Does the trie contain a given key?

fn get(&self, key: &[u8]) -> Result<Option<DBValue>, TrieHash<L>, CError<L>>

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