Struct Plan

pub struct Plan<I: Item> {
    pub collection_plans: Vec<CollectionPlan<I>>,
    pub stale_collections: Vec<MappingUid>,
    /* 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.

Fields

collection_plans: Vec<CollectionPlan<I>>

stale_collections: Vec<MappingUid>

Implementations

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.

Analyses the provided StoragePair, fetches necessary metadata, and prepares a plan of actions required to synchronise both storages.

This function only performs read operations. The status database should be opened in read-only mode.

Errors

See: PlanError.

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.