ratio-metadata 0.2.2

Ratio's metadata model.
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! # Transaction type module
//!
//! ## License
//!
//! This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
//! If a copy of the MPL was not distributed with this file,
//! You can obtain one at <https://mozilla.org/MPL/2.0/>.
//!
//! **Code examples both in the docstrings and rendered documentation are free to use.**

use std::collections::{BTreeMap, BTreeSet};
use std::fmt::Debug;

use uuid::Uuid;

use crate::metadata::{AnnotationValue, Field, WeightValue};

#[cfg(feature = "serde")]
fn is_default<T: Default + PartialEq>(value: &T) -> bool {
    value == &Default::default()
}

/// Transaction to apply to a MetadataStore.
#[derive(Clone, Debug, PartialEq, bon::Builder)]
#[cfg_attr(
    feature = "serde",
    derive(serde::Serialize, serde::Deserialize),
    serde(default, rename_all = "camelCase")
)]
#[builder(on(String, into))]
pub struct Transaction<N, K, L, W, WV, A, AV>
where
    N: Field,
    K: Field,
    L: Field,
    W: Field,
    WV: WeightValue,
    A: Field,
    AV: AnnotationValue,
{
    /// Transaction mode.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "is_default"))]
    #[builder(default)]
    pub mode: TransactionMode,

    /// Instance identifier.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[builder(into)]
    pub id: Option<Uuid>,

    /// Name associated with this instance.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[builder(into)]
    pub name: Option<N>,

    /// Kind of object or main category associated with this instance.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    #[builder(into)]
    pub kind: Option<K>,

    /// Set of labels associated with this instance.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub labels: Option<BTreeSet<L>>,

    /// Numerical weights associated with this instance.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub weights: Option<BTreeMap<W, WV>>,

    /// Free-form annotations associated with this instance.
    #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
    pub annotations: Option<BTreeMap<A, AV>>,
}
impl<N, K, L, W, WV, A, AV> Default for Transaction<N, K, L, W, WV, A, AV>
where
    N: Field,
    K: Field,
    L: Field,
    W: Field,
    WV: WeightValue,
    A: Field,
    AV: AnnotationValue,
{
    fn default() -> Self {
        Self {
            mode: Default::default(),
            id: Default::default(),
            name: Default::default(),
            kind: Default::default(),
            labels: Default::default(),
            weights: Default::default(),
            annotations: Default::default(),
        }
    }
}

impl<N, K, L, W, WV, A, AV> Transaction<N, K, L, W, WV, A, AV>
where
    N: Field,
    K: Field,
    L: Field,
    W: Field,
    WV: WeightValue,
    A: Field,
    AV: AnnotationValue,
{
    /// Strip the ID from the transaction.
    pub fn strip_id(&mut self) -> Option<Uuid> {
        self.id.take()
    }
}
/// Metadata transaction mode.
/// Whether to replace any existing value, or append to it where possible.
/// This mainly changes the behavior for sets and maps.
#[derive(Copy, Clone, Debug, Default, PartialEq)]
#[cfg_attr(
    feature = "serde",
    derive(serde::Serialize, serde::Deserialize),
    serde(rename_all = "camelCase")
)]
pub enum TransactionMode {
    Replace,
    #[default]
    Append,
}