solti-model 0.0.4

Domain model types for the Solti task execution SDK: task specs, states, and identifiers.
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

//! # Key-value pair
//!
//! [`KeyValue`] stores one ordered key-value entry.
//! It does not apply key or value format validation.

use serde::{Deserialize, Serialize};

/// Key-value pair used for environment variables or generic metadata.
///
/// ## Example
///
/// ```
/// use solti_model::KeyValue;
///
/// let kv = KeyValue::new("APP_MODE", "batch");
/// assert_eq!(kv.key(), "APP_MODE");
/// assert_eq!(kv.value(), "batch");
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[serde(deny_unknown_fields)]
pub struct KeyValue {
    /// Name of the variable or key.
    key: String,
    /// Value associated with the key.
    value: String,
}

impl KeyValue {
    /// Creates a key-value pair.
    #[inline]
    pub fn new<K, V>(key: K, value: V) -> Self
    where
        K: Into<String>,
        V: Into<String>,
    {
        Self {
            key: key.into(),
            value: value.into(),
        }
    }

    /// Returns the key.
    #[inline]
    pub fn key(&self) -> &str {
        &self.key
    }

    /// Returns the value.
    #[inline]
    pub fn value(&self) -> &str {
        &self.value
    }
}

impl From<(String, String)> for KeyValue {
    #[inline]
    fn from((key, value): (String, String)) -> Self {
        Self { key, value }
    }
}

impl From<(&str, &str)> for KeyValue {
    #[inline]
    fn from((key, value): (&str, &str)) -> Self {
        Self {
            key: key.to_string(),
            value: value.to_string(),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::KeyValue;

    #[test]
    fn constructors_and_equality_preserve_key_and_value() {
        let expected = KeyValue::new("FOO", "bar");
        let from_str: KeyValue = ("FOO", "bar").into();
        let from_string: KeyValue = (String::from("FOO"), String::from("bar")).into();

        assert_eq!(expected.key(), "FOO");
        assert_eq!(expected.value(), "bar");
        assert_eq!(from_str, expected);
        assert_eq!(from_string, expected);
        assert_ne!(KeyValue::new("FOO", "baz"), expected);
    }

    #[test]
    fn serde_roundtrip_preserves_fields() {
        let kv = KeyValue::new("FOO", "bar");
        let json = serde_json::to_string(&kv).unwrap();
        assert_eq!(json, r#"{"key":"FOO","value":"bar"}"#);
        let back: KeyValue = serde_json::from_str(&json).unwrap();
        assert_eq!(back, kv);
    }
}