Struct Plan 

pub struct Plan<B: Backend> {
    repository: RepoRef,
    operations: Vec<B::Operation>,
    report: Report,
}

A pure reconciliation plan bound to one target repository.

Fields

repository: RepoRef

operations: Vec<B::Operation>

report: Report

Implementations

impl<B: Backend> Plan<B>

pub async fn for_repository( repository: RepoRef, config: &B::Config, backend: &B, ) -> Result<Self, PlanError<B::Error>>

where B: Sync,

Read a repository and construct its reconciliation plan.

Errors

Returns an error when the configuration is invalid or the adapter cannot read the target repository.

pub fn for_snapshot( repository: RepoRef, config: &B::Config, live: &B::Live, ) -> Self

Construct a plan from a previously read snapshot.

pub const fn repository(&self) -> &RepoRef

The repository this plan targets.

pub fn operations(&self) -> &[B::Operation]

The operations in their stable application order.

pub const fn report(&self) -> &Report

The change report.

pub fn refusal(&self) -> Option<Refusal>

The reason the plan cannot be applied, if any.

pub async fn apply(&self, backend: &B) -> Result<(), PlanError<B::Error>>

where B: Sync,

Apply each operation in order.

Errors

Returns an error when the plan locks the caller out, the repository is archived or an operation fails.

Trait Implementations

impl<B: Backend> Debug for Plan<B>

where B::Operation: Debug,

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

Formats the value using the given formatter.