Struct Any 

pub struct Any<E: Storage + Clock + Metrics, K: Array, V: CodecFixed<Cfg = ()>, H: CHasher, T: Translator> { /* private fields */ }

A key-value ADB based on an MMR over its log of operations, supporting authentication of any value ever associated with a key.

Implementations

impl<E: Storage + Clock + Metrics, K: Array, V: CodecFixed<Cfg = ()>, H: CHasher, T: Translator> Any<E, K, V, H, T>

pub async fn init(context: E, cfg: Config<T>) -> Result<Self, Error>

Returns an Any adb initialized from cfg. Any uncommitted log operations will be discarded and the state of the db will be as of the last committed operation.

pub async fn get(&self, key: &K) -> Result<Option<V>, Error>

Get the value of key in the db, or None if it has no value.

pub fn op_count(&self) -> Location

Get the number of operations that have been applied to this db, including those that are not yet committed.

pub fn is_empty(&self) -> bool

Whether the db currently has no active keys.

pub fn inactivity_floor_loc(&self) -> Location

Return the inactivity floor location. This is the location before which all operations are known to be inactive.

pub async fn update(&mut self, key: K, value: V) -> Result<(), Error>

Updates key to have value value. The operation is reflected in the snapshot, but will be subject to rollback until the next successful commit.

pub async fn delete(&mut self, key: K) -> Result<Option<Location>, Error>

Delete key and its value from the db. Deleting a key that already has no value is a no-op. The operation is reflected in the snapshot, but will be subject to rollback until the next successful commit. Returns the location of the deleted value for the key (if any).

pub fn root(&self, hasher: &mut Standard<H>) -> H::Digest

Return the root of the db.

Warning

Panics if there are uncommitted operations.

pub async fn proof( &self, start_loc: Location, max_ops: NonZeroU64, ) -> Result<(Proof<H::Digest>, Vec<Operation<K, V>>), Error>

Generate and return:

1. a proof of all operations applied to the db in the range starting at (and including) location start_loc, and ending at the first of either:
   • the last operation performed, or
   • the operation max_ops from the start.
2. the operations corresponding to the leaves in this range.

Errors

Returns crate::mmr::Error::LocationOverflow if start_loc > crate::mmr::MAX_LOCATION. Returns crate::mmr::Error::RangeOutOfBounds if start_loc >= op_count.

pub async fn historical_proof( &self, op_count: Location, start_loc: Location, max_ops: NonZeroU64, ) -> Result<(Proof<H::Digest>, Vec<Operation<K, V>>), Error>

Analogous to proof, but with respect to the state of the MMR when it had op_count operations.

Errors

Returns crate::mmr::Error::LocationOverflow if op_count or start_loc > crate::mmr::MAX_LOCATION. Returns crate::mmr::Error::RangeOutOfBounds if start_loc >= op_count.

pub async fn commit(&mut self) -> Result<(), Error>

Commit any pending operations to the database, ensuring their durability upon return from this function. Also raises the inactivity floor according to the schedule.

Failures after commit (but before sync or close) may still require reprocessing to recover the database on restart.

pub async fn sync(&mut self) -> Result<(), Error>

Sync all database state to disk. While this isn’t necessary to ensure durability of committed operations, periodic invocation may reduce memory usage and the time required to recover the database on restart.

pub async fn prune(&mut self, target_prune_loc: Location) -> Result<(), Error>

Prune historical operations prior to target_prune_loc. This does not affect the db’s root or current snapshot.

Errors

• Returns crate::mmr::Error::LocationOverflow if target_prune_loc > crate::mmr::MAX_LOCATION.
• Returns crate::mmr::Error::RangeOutOfBounds if target_prune_loc is greater than the inactivity floor.

pub async fn close(self) -> Result<(), Error>

Close the db. Operations that have not been committed will be lost or rolled back on restart.

pub async fn destroy(self) -> Result<(), Error>

Destroy the db, removing all data from disk.

Trait Implementations

impl<E: Storage + Clock + Metrics, K: Array, V: CodecFixed<Cfg = ()>, H: CHasher, T: Translator> Db<E, K, V, T> for Any<E, K, V, H, T>

fn op_count(&self) -> Location

The number of operations that have been applied to this db, including those that have been pruned and those that are not yet committed.

fn inactivity_floor_loc(&self) -> Location

Return the inactivity floor location. This is the location before which all operations are known to be inactive. Operations before this point can be safely pruned.

async fn get(&self, key: &K) -> Result<Option<V>, Error>

Get the value of key in the db, or None if it has no value.

async fn update(&mut self, key: K, value: V) -> Result<(), Error>

Updates key to have value value. The operation is reflected in the snapshot, but will be subject to rollback until the next successful commit.

async fn delete(&mut self, key: K) -> Result<(), Error>

Delete key and its value from the db. Deleting a key that already has no value is a no-op. The operation is reflected in the snapshot, but will be subject to rollback until the next successful commit.

async fn commit(&mut self) -> Result<(), Error>

Commit any pending operations to the database, ensuring their durability upon return from this function. Also raises the inactivity floor according to the schedule.

async fn sync(&mut self) -> Result<(), Error>

Sync all database state to disk. While this isn’t necessary to ensure durability of committed operations, periodic invocation may reduce memory usage and the time required to recover the database on restart.

async fn prune(&mut self, target_prune_loc: Location) -> Result<(), Error>

Prune historical operations prior to target_prune_loc. This does not affect the db’s root or current snapshot.

async fn close(self) -> Result<(), Error>

Close the db. Operations that have not been committed will be lost or rolled back on restart.

async fn destroy(self) -> Result<(), Error>

Destroy the db, removing all data from disk.