vstorage 0.8.1

Common API for various icalendar/vcard storages.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

// Copyright 2023-2026 Hugo Osvaldo Barrera
//
// SPDX-License-Identifier: EUPL-1.2

//! Synchronisation policies for deciding what operations to perform.
//!
//! The [`Mode`] trait and its implementations decide what synchronisation operations to
//! perform based on detected state changes.

use std::sync::Arc;

use super::{
    items::SideState,
    mapping::ResolvedMapping,
    operation::{ItemOp, MappingUidSource, PropertyOp},
    ordering::DeletionBarrier,
    status::{ItemPairStatus, MappingUid},
};
use crate::property::Property;

/// Mode of operation for deciding which synchronisation operations to perform.
///
/// Separates the decision-making logic from state comparison. Different implementations can
/// provide different synchronisation behaviors (two-way, one-way, etc.).
pub trait Mode: Send + Sync {
    /// Decide which item operation to perform based on item state.
    ///
    /// Returns `None` if no operation is needed.
    fn decide_item_action(
        &self,
        side_a: Option<SideState>,
        side_b: Option<SideState>,
        previous: Option<ItemPairStatus>,
        mapping: &Arc<ResolvedMapping>,
        mapping_uid_source: MappingUidSource,
        on_complete: Option<&DeletionBarrier>,
    ) -> Option<ItemOp>;

    /// Decide which property operation to perform based on property state.
    ///
    /// Returns `None` if no operation is needed.
    #[allow(clippy::too_many_arguments)]
    fn decide_property_action(
        &self,
        property: Property,
        value_a: Option<String>,
        value_b: Option<String>,
        previous: Option<String>,
        mapping: &Arc<ResolvedMapping>,
        mapping_uid: MappingUid,
        on_complete: Option<&DeletionBarrier>,
    ) -> Option<PropertyOp>;
}