Struct StoragePair 

pub struct StoragePair { /* private fields */ }

A pair of storage that are to be synchronised.

Merely wraps around the declaration of what shall be synchronised. It can be constructed offline and is the entry point to generate a stream of operations via Plan::new and then execute them.

New pairs can be created via StoragePair::new.

Implementations

impl StoragePair

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

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: SyncedCollection) -> 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) -> &Arc<dyn Storage>

Returns a reference to storage a.

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

Returns a reference to storage a.

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

Action to take when a collection is completely emptied.

pub fn on_delete(self, action: OnDelete) -> Self

Action to take when a collection is deleted.

pub fn with_mode(self, mode: Arc<dyn Mode>) -> Self

Set the synchronization mode.

By default, TwoWaySync is used.

Trait Implementations

impl Clone for StoragePair

fn clone(&self) -> StoragePair

Returns a duplicate of the value.

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

Performs copy-assignment from source.