Struct Any 

pub struct Any<E: RStorage + Clock + Metrics, K: Array, V: Codec, 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: RStorage + Clock + Metrics, K: Array, V: Codec, H: CHasher, T: Translator> Any<E, K, V, H, T>

pub async fn init( context: E, cfg: Config<T, <Operation<K, V> as Read>::Cfg>, ) -> Result<Self, Error>

Returns a 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 async fn get_loc(&self, loc: u64) -> Result<Option<V>, Error>

Get the value of the operation with location loc in the db. Returns Error::OperationPruned if loc precedes the oldest retained location. The location is otherwise assumed valid.

Panics

Panics if loc is greater than or equal to the number of operations in the log.

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

Returns the location of the operation that set the key’s current value, or None if the key isn’t currently assigned any value.

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

Get the value of the operation with location loc in the db if it matches key. The location is assumed valid.

Panics

Panics if loc is greater than or equal to the number of operations in the log.

pub fn op_count(&self) -> u64

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

pub fn oldest_retained_loc(&self) -> Option<u64>

Return the oldest location that remains retrievable.

pub fn inactivity_floor_loc(&self) -> u64

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<(), 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.

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: u64, max_ops: u64, ) -> 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.

Warning

Panics if there are uncommitted operations.

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

Analogous to proof, but with respect to the state of the MMR when it had size elements.

Panics

• Panics if start_loc greater than or equal to size.
• Panics if size is greater than the number of operations.

pub async fn commit(&mut self, metadata: Option<V>) -> 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. Caller can associate an arbitrary metadata value with the commit.

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

pub async fn get_metadata(&self) -> Result<Option<(u64, Option<V>)>, Error>

Get the location and metadata associated with the last commit, or None if no commit has been made.

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: u64) -> Result<(), Error>

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

Panics

Panics 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.

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

Destroy the db, removing all data from disk.