Struct ReplicatedStoreHandle 

pub struct ReplicatedStoreHandle<S>
where
    S: Storage,
{ /* private fields */ }

A cheaply cloneable handle to control the data store.

Implementations

impl<S> ReplicatedStoreHandle<S>

where S: Storage,

pub fn statistics(&self) -> &SystemStatistics

Gets the live cluster statistics.

pub fn with_keyspace( &self, keyspace: impl Into<String>, ) -> ReplicatorKeyspaceHandle<S>

Creates a new handle to the underlying storage system with a preset keyspace.

Changes applied to the handle are distributed across the cluster.

pub async fn get( &self, keyspace: &str, doc_id: Key, ) -> Result<Option<Document>, S::Error>

Retrieves a document from the underlying storage.

pub async fn get_many<I, T>( &self, keyspace: &str, doc_ids: I, ) -> Result<S::DocsIter, S::Error>

where T: Iterator<Item = Key> + Send, I: IntoIterator<IntoIter = T> + Send,

Retrieves a set of documents from the underlying storage.

If a document does not exist with the given ID, it is simply not part of the returned iterator.

pub async fn put<D>( &self, keyspace: &str, doc_id: Key, data: D, consistency: Consistency, ) -> Result<(), StoreError<S::Error>>

where D: Into<Vec<u8>>,

Insert or update a single document into the datastore.

pub async fn put_many<I, T, D>( &self, keyspace: &str, documents: I, consistency: Consistency, ) -> Result<(), StoreError<S::Error>>

where D: Into<Vec<u8>>, T: Iterator<Item = (Key, D)> + Send, I: IntoIterator<IntoIter = T> + Send,

Insert or update multiple documents into the datastore at once.

pub async fn del( &self, keyspace: &str, doc_id: Key, consistency: Consistency, ) -> Result<(), StoreError<S::Error>>

Delete a document from the datastore with a given doc ID.

pub async fn del_many<I, T>( &self, keyspace: &str, doc_ids: I, consistency: Consistency, ) -> Result<(), StoreError<S::Error>>

where T: Iterator<Item = Key> + Send, I: IntoIterator<IntoIter = T> + Send,

Delete multiple documents from the datastore from the set of doc IDs.

Trait Implementations

impl<S> Clone for ReplicatedStoreHandle<S>

where S: Storage,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.