Struct grovedb_merk::tree::RefWalker

pub struct RefWalker<'a, S>
where
    S: Fetch + Sized + Clone,
{ /* private fields */ }

Allows read-only traversal of a Tree, fetching from the given source when traversing to a pruned node. The fetched nodes are then retained in memory until they (possibly) get pruned on the next commit.

Only finalized trees may be walked (trees which have had commit called since the last update).

Implementations

impl<'a, S> RefWalker<'a, S>

where S: Fetch + Sized + Clone,

pub fn create_chunk( &mut self, depth: usize, grove_version: &GroveVersion, ) -> Result<Vec<Op>, Error>

Returns a chunk of a given depth from a RefWalker

pub fn traverse_and_build_chunk( &mut self, instructions: &[bool], depth: usize, grove_version: &GroveVersion, ) -> Result<Vec<Op>, Error>

Returns a chunk of a given depth after applying some traversal instruction to the RefWalker

pub fn generate_height_proof( &mut self, proof: &mut Vec<Op>, grove_version: &GroveVersion, ) -> CostResult<(), Error>

Returns the smallest amount of tree ops, that can convince a verifier of the tree height the generated subtree is of this form kv_hash /
kv_hash node_hash /
kv_hash node_hash . . .

impl<'a, S> RefWalker<'a, S>

where S: Fetch + Sized + Clone,

pub fn new(tree: &'a mut TreeNode, source: S) -> Self

Creates a RefWalker with the given tree and source.

pub fn tree(&self) -> &TreeNode

Gets an immutable reference to the Tree wrapped by this RefWalker.

pub fn walk<V>( &mut self, left: bool, value_defined_cost_fn: Option<&V>, grove_version: &GroveVersion, ) -> CostResult<Option<RefWalker<'_, S>>, Error>

where V: Fn(&[u8], &GroveVersion) -> Option<ValueDefinedCostType>,

Traverses to the child on the given side (if any), fetching from the source if pruned. When fetching, the link is upgraded from Link::Reference to Link::Loaded.