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

/// Describes the result of an update operation performed on a [`DittoMutDocument`].
///
/// - set: Describes the `set` update that was performed.
/// - removed: Describes the `remove` update that was performed.
/// - incremented: Describes the `increment` update that was performed.
///
/// [`DittoMutDocument`]: crate::store::query_builder::DittoMutDocument
pub struct UpdateResult {
    /// The type of update operation performed.
    pub op: UpdateOp,

    /// The ID of the document updated.
    pub doc_id: String,

    /// The path to the field in the document that was updated.
    pub path: String,

    /// A printable representation of the updated value.
    pub value: Box<dyn std::fmt::Debug>, // we only care if we can print the value
}

/// Update operation performed on a `DittoMutDocument`.
pub enum UpdateOp {
    /// Describes the `set` update that was performed.
    Set,

    /// Describes the `remove` update that was performed.
    Removed,

    /// Describes the `replace_with_counter` update that was performed.
    ReplacedWithCounter,

    /// Describes the `increment` update that was performed.
    Incremented,
}