Enum ItemAction

pub enum ItemAction<I: Item> {
    SaveToStatus {
        a: ItemRef,
        b: ItemRef,
        uid: String,
        hash: ItemHash,
    },
    UpdateStatus {
        hash: ItemHash,
        old: (ItemRef, ItemRef),
        new: (ItemRef, ItemRef),
    },
    ClearStatus {
        uid: String,
    },
    Create {
        side: Side,
        source: ItemState<I>,
    },
    Update {
        side: Side,
        source: ItemState<I>,
        target: ItemRef,
        old: (ItemRef, ItemRef),
    },
    Delete {
        side: Side,
        target: ItemRef,
        uid: String,
    },
    Conflict {
        a: ItemState<I>,
        b: ItemState<I>,
        old: Option<(ItemRef, ItemRef)>,
    },
}

Operation to execute on an item during synchronising.

These actions contain all data necessary to execute them and update the status database. They only lack a MappingUid, since this may be resolved at execution time (e.g.: if the collection does not exist).

Variants

SaveToStatus

Item is new and identical on both sides.

Fields

a: ItemRef

b: ItemRef

uid: String

hash: ItemHash

UpdateStatus

Update the status DB.

Item has changed on both sides, but remains in sync. The old field contains data to update the status db atomically.

Fields

hash: ItemHash

old: (ItemRef, ItemRef)

new: (ItemRef, ItemRef)

ClearStatus

Item is gone from both sides but still present in status db.

Fields

uid: String

Create

Fields

side: Side

source: ItemState<I>

Update

Update an item with data from the other side.

The old field contains data to update the status db atomically.

Fields

side: Side

source: ItemState<I>

target: ItemRef

old: (ItemRef, ItemRef)

Delete

Fields

side: Side

target: ItemRef

uid: String

Conflict

Item is in conflict which needs to be resolved externally.

Fields

a: ItemState<I>

b: ItemState<I>

old: Option<(ItemRef, ItemRef)>

Implementations

impl<I: Item> ItemAction<I>

pub fn keep_a(self) -> Self

If this item is a conflict, rewrite the action to keep data from side A.

pub fn keep_b(self) -> Self

If this item is a conflict, rewrite the action to keep data from side B.

Trait Implementations

impl<I: Clone + Item> Clone for ItemAction<I>

fn clone(&self) -> ItemAction<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Debug + Item> Debug for ItemAction<I>

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

Formats the value using the given formatter.

impl<I: Item> Display for ItemAction<I>

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

This function is mostly implemented to be used for error reporting.

impl<I: PartialEq + Item> PartialEq for ItemAction<I>

fn eq(&self, other: &ItemAction<I>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I: Item> StructuralPartialEq for ItemAction<I>