reth_trie/trie_cursor/
mod.rs

Help
1use crate::{BranchNodeCompact, Nibbles};
2use alloy_primitives::B256;
3use reth_storage_errors::db::DatabaseError;
4
5/// In-memory implementations of trie cursors.
6mod in_memory;
7
8/// Cursor for iterating over a subtrie.
9mod subnode;
10
11/// Noop trie cursor implementations.
12pub mod noop;
13
14pub use self::{in_memory::*, subnode::CursorSubNode};
15
16/// Factory for creating trie cursors.
17#[auto_impl::auto_impl(&)]
18pub trait TrieCursorFactory {
19    /// The account trie cursor type.
20    type AccountTrieCursor: TrieCursor;
21    /// The storage trie cursor type.
22    type StorageTrieCursor: TrieCursor;
23
24    /// Create an account trie cursor.
25    fn account_trie_cursor(&self) -> Result<Self::AccountTrieCursor, DatabaseError>;
26
27    /// Create a storage tries cursor.
28    fn storage_trie_cursor(
29        &self,
30        hashed_address: B256,
31    ) -> Result<Self::StorageTrieCursor, DatabaseError>;
32}
33
34/// A cursor for navigating a trie that works with both Tables and DupSort tables.
35#[auto_impl::auto_impl(&mut, Box)]
36pub trait TrieCursor: Send + Sync {
37    /// Move the cursor to the key and return if it is an exact match.
38    fn seek_exact(
39        &mut self,
40        key: Nibbles,
41    ) -> Result<Option<(Nibbles, BranchNodeCompact)>, DatabaseError>;
42
43    /// Move the cursor to the key and return a value matching of greater than the key.
44    fn seek(&mut self, key: Nibbles)
45        -> Result<Option<(Nibbles, BranchNodeCompact)>, DatabaseError>;
46
47    /// Move the cursor to the next key.
48    fn next(&mut self) -> Result<Option<(Nibbles, BranchNodeCompact)>, DatabaseError>;
49
50    /// Get the current entry.
51    fn current(&mut self) -> Result<Option<Nibbles>, DatabaseError>;
52}
reth_trie/trie_cursor/mod.rs

reth_trie/trie_cursor/
mod.rs
