vstorage

Module sync

source
Expand description

Components used for synchronising storages.

The general gist behind synchronising is:

  • Create a new declare::StoragePair. This type specifies which storages and which collections are to be synchronised. A status::StatusDatabase instance with details of the previous synchronisation should be provided, if it exists.
  • plan::Plan::new is used to create a Plan. This contains a list of actions to be executed to synchronise both storages. This instance can also be inspected before executing any actions (e.g.: as a from of dry-run).
  • The plan may have conflicting items (represented as ItemAction::Conflict). These MAY be replaced with different actions (e.g.: ItemAction::Update to overwrite data in one storage with data from the other).
    • If resolving conflicts requires writing a merged file into both storages, this needs to be done using the Storage APIs directly. The next synchronisation will detect the resolved conflict automatically and update the status database.
  • Use plan::Plan::execute to execute the plan itself. It updates the status to reflect which items exist on both side and their metadata. This will be used on the next cycle to understand which items have changed on which sides.

The synchronization algorithm is based on the algorithm from the original vdirsyncer.

Modules§

  • declare
    Types for specifying rules for a synchronisation.
  • plan
    Plan for a synchronisation.
  • status
    Store and query status between synchronisations.

Structs§

  • SyncError
    An error synchronising two items between storages.

Enums§