Struct vstorage::sync::declare::StoragePair

pub struct StoragePair<I: Item> { /* private fields */ }

A pair of storage that are to be synchronised.

This type merely wraps around the declaration of what shall be synchronised. It can be constructed offline and is the entry point to create a Plan and then execute it.

New pairs can be created via StoragePair::new.

Implementations

impl<I: Item> StoragePair<I>

pub fn new( storage_a: Arc<dyn Storage<I>>, storage_b: Arc<dyn Storage<I>>, ) -> StoragePair<I>

Create a new instance.

By default, no collections are to be synchronised. See other associated functions for details con configuring additional collections.

pub fn with_mapping(self, mapping: DeclaredMapping) -> Self

Include the specified mapping when synchronising.

pub fn with_all_from_a(self) -> Self

Include all collections from storage A when synchronising.

By default, only explicitly included collections are synchronised.

pub fn with_all_from_b(self) -> Self

Include all collections from storage B when synchronising.

By default, only explicitly included collections are synchronised.

pub fn storage_a(&self) -> &dyn Storage<I>

Returns a reference to storage a.

pub fn storage_b(&self) -> &dyn Storage<I>

Returns a reference to storage a.

pub fn on_empty(self, action: OnEmpty) -> Self

Action to take when a collection is completely emptied.