Struct vstorage::sync::plan::Plan

pub struct Plan<I: Item> {
    pub collection_plans: Vec<CollectionPlan<I>>,
    /* private fields */
}

Actions that would synchronise a pair of storages.

Use Plan::new to create new instances.

Use Plan::collection_plans) to inspect the plan and render it into a human-friendly representation, into a CSV, or into any other format that is necessary.

Use Plan::execute to execute this plan and apply changes to the provided Storage instances.

Fields

collection_plans: Vec<CollectionPlan<I>>

Implementations

impl<I: Item> Plan<I>

pub async fn execute( self, status: &StatusDatabase, on_error: impl Fn(SyncError), ) -> Result<(), StatusError>

Executes a synchronization plan.

Non-fatal errors

When a non-fatal error occurs (e.g.: an item being uploaded is rejected), the on_error function will be called with details on the exact error.

Errors

A StatusError is returned in case writing to the status database fails.

impl<I: Item> Plan<I>

pub async fn new( pair: &StoragePair<I>, status: Option<&StatusDatabase>, ) -> Result<Plan<I>, PlanError>

Create a new plan for a given storage pair.

Errors

Returns an error if:

• There is an error discovering remote collections.
• A mapping is defined by collection id, but the id is invalid for the underlying storage.
• There is an error reading the state of existing items.
• The same collection is mapped more than once.

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

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

Trait Implementations

impl<I: Item> Debug for Plan<I>

Show details of the plan itself.

This is partially necessary because storages don’t yet implement Debug .

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

Formats the value using the given formatter.