Struct AnyExt 

pub struct AnyExt<A: CleanAny> { /* private fields */ }

An extension wrapper for CleanAny databases that provides a traditional mutable key-value store interface by internally handling Clean/Dirty state transitions.

Implementations

impl<A: CleanAny> AnyExt<A>

pub const fn new(db: A) -> Self

Create a new wrapper from a Clean Any database.

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

Close the database without destroying it. Uncommitted operations may be lost.

Trait Implementations

impl<A> Batchable for AnyExt<A>

where A: CleanAny, <A as CleanStore>::Dirty: Batchable<Key = A::Key, Value = A::Value>,

async fn write_batch( &mut self, iter: impl Iterator<Item = (Self::Key, Option<Self::Value>)>, ) -> Result<(), Error>

Writes a batch of changes to the database.

fn start_batch(&self) -> Batch<'_, Self::Key, Self::Value, Self>

where Self: Sized,

Returns a new empty batch of changes.

impl<A> LogStore for AnyExt<A>

where A: CleanAny,

type Value = <A as LogStore>::Value

fn is_empty(&self) -> bool

Returns true if there are no active keys in the database.

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_metadata(&self) -> Result<Option<Self::Value>, Error>

Get the metadata associated with the last commit.

impl<A> LogStorePrunable for AnyExt<A>

where A: CleanAny,

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

Prune historical operations prior to prune_loc.

impl<A> Store for AnyExt<A>

where A: CleanAny,

type Key = <A as CleanAny>::Key

type Value = <A as LogStore>::Value

type Error = Error

async fn get(&self, key: &Self::Key) -> Result<Option<Self::Value>, Self::Error>

Get the value of a key.

impl<A> StoreDeletable for AnyExt<A>

where A: CleanAny,

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

Delete the value of a key.

impl<A> StoreMut for AnyExt<A>

where A: CleanAny,

async fn update( &mut self, key: Self::Key, value: Self::Value, ) -> Result<(), Self::Error>

Update the value of a key.

fn upsert( &mut self, key: Self::Key, update: impl FnOnce(&mut Self::Value), ) -> impl Future<Output = Result<(), Self::Error>>

where Self::Value: Default,

Updates the value associated with the given key in the store, inserting a default value if the key does not already exist.

fn create( &mut self, key: Self::Key, value: Self::Value, ) -> impl Future<Output = Result<bool, Self::Error>>

Creates a new key-value pair in the db. Returns true if the key was created, false if it already existed.

impl<A> StorePersistable for AnyExt<A>

where A: CleanAny,

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

Commit the store to disk, ensuring all changes are durably persisted.

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

Destroy the store, removing all persisted data.