Struct MicroKV 

pub struct MicroKV { /* private fields */ }

The database handle. Cheap to clone (Arc-backed); all clones share one store.

Operations on the default namespace (get, put, keys, …) are available directly via Deref to the default Tree; store-wide operations (namespace, transaction, save, rekey, …) are inherent methods.

Implementations

impl MicroKV

pub fn in_memory(cred: Credential) -> Result<Self>

pub fn in_memory_with(cred: Credential, config: Config) -> Result<Self>

pub fn open(path: impl AsRef<Path>, cred: Credential) -> Result<Self>

Open, creating the store if it doesn’t exist.

pub fn open_with( path: impl AsRef<Path>, cred: Credential, config: Config, ) -> Result<Self>

MicroKV::open with explicit Config.

pub fn open_existing(path: impl AsRef<Path>, cred: Credential) -> Result<Self>

Fails if the store doesn’t exist.

pub fn open_existing_with( path: impl AsRef<Path>, cred: Credential, config: Config, ) -> Result<Self>

MicroKV::open_existing with explicit Config.

pub fn create_new(path: impl AsRef<Path>, cred: Credential) -> Result<Self>

Fails if the store already exists.

pub fn create_new_with( path: impl AsRef<Path>, cred: Credential, config: Config, ) -> Result<Self>

MicroKV::create_new with explicit Config.

pub fn namespace(&self, name: impl AsRef<str>) -> Tree

An isolated namespace: keys never collide across namespaces, and each value’s ciphertext is bound to its namespace. MicroKV derefs to the default ("") one.

pub fn tree_names(&self) -> Result<Vec<String>>

Namespaces that currently hold data.

pub fn transaction<F, R>(&self, f: F) -> Result<R>

where F: FnOnce(&mut Txn<'_>) -> Result<R>,

Run ops under one write lock against a working copy: commit on Ok, roll back on Err. Namespaces are explicit ("" is the default).

pub fn kdf_params(&self) -> KdfParams

pub fn change_password( &self, old: impl Into<String>, new: impl Into<String>, ) -> Result<()>

Verify old, then re-key everything under new.

pub fn rekey(&self, new: Credential) -> Result<()>

Re-derive the key from new (fresh salt) and re-encrypt every entry + the verifier.

pub fn save(&self) -> Result<()>

Persist to the store’s path; errors (Error::NoPath) for in-memory stores.

pub fn save_as(&self, path: impl AsRef<Path>) -> Result<()>

Persist a copy elsewhere, leaving the store’s own path unchanged.

pub fn export(&self) -> Result<Vec<u8>>

The encrypted store as bytes (no filesystem access).

pub fn destroy(self) -> Result<()>

Clear all data and delete the file + its .lock sidecar.

pub fn sweep_expired(&self) -> Result<usize>

Drop every expired entry, returning the count. Entries are authenticated before their (encrypted) expiry is trusted, so a tampered expiry errors instead of dropping a live value.

Methods from Deref<Target = Tree>

pub fn name(&self) -> &str

"" for the default namespace.

pub fn get<V: DeserializeOwned>(&self, key: &str) -> Result<Option<V>>

pub fn require<V: DeserializeOwned>(&self, key: &str) -> Result<V>

pub fn get_secret<V: DeserializeOwned>( &self, key: &str, ) -> Result<Option<Secret<V>>>

Tree::get, wrapped in a non-logging Secret.

pub fn put<V: Serialize>(&self, key: &str, value: &V) -> Result<()>

pub fn put_with_ttl<V: Serialize>( &self, key: &str, value: &V, ttl: Duration, ) -> Result<()>

pub fn remove(&self, key: &str) -> Result<bool>

pub fn contains(&self, key: &str) -> Result<bool>

pub fn len(&self) -> Result<usize>

pub fn is_empty(&self) -> Result<bool>

pub fn update<V, F>(&self, key: &str, f: F) -> Result<()>

where V: Serialize + DeserializeOwned, F: FnOnce(Option<V>) -> Option<V>,

Atomic read-modify-write under one lock. Returning None removes the key.

pub fn get_or_insert_with<V, F>(&self, key: &str, f: F) -> Result<V>

where V: Serialize + DeserializeOwned, F: FnOnce() -> V,

pub fn compare_and_swap<V: Serialize + DeserializeOwned>( &self, key: &str, expected: Option<&V>, new: Option<&V>, ) -> Result<bool>

Swap to new only if the current value equals expected (by serialized bytes).

pub fn keys(&self) -> Result<Vec<String>>

Live keys (expired entries excluded).

pub fn keys_sorted(&self) -> Result<Vec<String>>

pub fn prefix<V: DeserializeOwned>( &self, prefix: &str, ) -> Result<Vec<(String, V)>>

Entries whose key starts with prefix (decrypts each match).

pub fn for_each<V, F>(&self, f: F) -> Result<()>

where V: DeserializeOwned, F: FnMut(&str, V) -> ControlFlow<()>,

Visit every live entry; return Break to stop early.

pub fn clear(&self) -> Result<()>

Trait Implementations

impl Clone for MicroKV

fn clone(&self) -> MicroKV

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MicroKV

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for MicroKV

type Target = Tree

The resulting type after dereferencing.

fn deref(&self) -> &Tree

Dereferences the value.