Struct KvStoreHandle 

pub struct KvStoreHandle { /* private fields */ }

Handle for interacting with a replicated key-value store.

Provides async methods for putting, getting, and removing entries. Changes are automatically replicated to peers via gossip.

Implementations

impl KvStoreHandle

pub fn peer_id(&self) -> PeerId

Return this handle’s gossip peer id.

pub async fn put( &self, key: String, value: Vec<u8>, content_type: String, ) -> Result<()>

Put a key-value pair into the store.

If the key already exists, the value is updated. Changes are automatically replicated to peers via gossip.

Errors

Returns an error if the value exceeds the maximum inline size (64 KB).

pub async fn put_with_delta( &self, key: String, value: Vec<u8>, content_type: String, ) -> Result<KvStoreDelta>

Put a key-value pair and return the CRDT delta that was published.

This is used by API-layer delivery fallbacks that need to carry the exact same mutation over a side channel when pub/sub is congested.

Errors

Returns an error if the value exceeds the maximum inline size (64 KB).

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

Get a value by key.

Returns None if the key does not exist or has been removed.

Errors

Returns an error if the store cannot be read.

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

Remove a key from the store.

Errors

Returns an error if the key does not exist.

pub async fn remove_with_delta(&self, key: &str) -> Result<KvStoreDelta>

Remove a key and return the CRDT delta that was published.

Errors

Returns an error if the key does not exist.

pub async fn apply_remote_delta( &self, peer_id: PeerId, delta: &KvStoreDelta, writer: Option<AgentId>, ) -> Result<()>

Apply a verified remote delta received through a non-pubsub channel.

Errors

Returns an error if the delta fails to merge into the local store.

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

List all active keys in the store.

Errors

Returns an error if the store cannot be read.

pub async fn name(&self) -> Result<String>

Get the store name.

Errors

Returns an error if the store cannot be read.

Trait Implementations

impl Clone for KvStoreHandle

fn clone(&self) -> KvStoreHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KvStoreHandle

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

Formats the value using the given formatter.