solti-model 0.0.1

Solti SDK domain 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

//! # Generic key-value pair.
//!
//! [`KeyValue`] is used for environment variables and other ordered pair collections.

use serde::{Deserialize, Serialize};

/// Key–value pair used for environment variables or generic metadata.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct KeyValue {
    /// Name of the variable or key.
    key: String,
    /// Value associated with the key.
    value: String,
}

impl KeyValue {
    /// Create a new 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(),
        }
    }

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

    /// Get 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 new_sets_key_and_value() {
        let kv = KeyValue::new("FOO", "bar");
        assert_eq!(kv.key(), "FOO");
        assert_eq!(kv.value(), "bar");
    }

    #[test]
    fn from_str_tuple_creates_keyvalue() {
        let kv: KeyValue = ("FOO", "bar").into();
        assert_eq!(kv.key(), "FOO");
        assert_eq!(kv.value(), "bar");
    }

    #[test]
    fn from_string_tuple_creates_keyvalue() {
        let kv: KeyValue = (String::from("FOO"), String::from("bar")).into();
        assert_eq!(kv.key(), "FOO");
        assert_eq!(kv.value(), "bar");
    }

    #[test]
    fn equality_works_for_same_key_and_value() {
        let a = KeyValue::new("FOO", "bar");
        let b = KeyValue::new("FOO", "bar");
        let c = KeyValue::new("FOO", "baz");

        assert_eq!(a, b);
        assert_ne!(a, c);
    }

    #[test]
    fn serde_roundtrip_json() {
        let kv = KeyValue::new("FOO", "bar");
        let json = serde_json::to_string(&kv).unwrap();

        assert!(json.contains("\"key\":\"FOO\""));
        assert!(json.contains("\"value\":\"bar\""));

        let back: KeyValue = serde_json::from_str(&json).unwrap();
        assert_eq!(back.key(), "FOO");
        assert_eq!(back.value(), "bar");
    }
}