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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
use crate::serde_str::{deserialize_from_str, serialize_to_str};
use derive_more::{From, IntoIterator};
use serde::{de::Deserializer, ser::Serializer, Deserialize, Serialize};
use std::{
collections::HashMap,
fmt,
ops::{Deref, DerefMut},
str::FromStr,
};
#[derive(Clone, Debug, From, IntoIterator, PartialEq, Eq)]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
pub struct Map(HashMap<String, String>);
impl Map {
pub fn new() -> Self {
Self(HashMap::new())
}
pub fn into_map(self) -> HashMap<String, String> {
self.0
}
}
#[cfg(feature = "schemars")]
impl Map {
pub fn root_schema() -> schemars::schema::RootSchema {
schemars::schema_for!(Map)
}
}
impl Default for Map {
fn default() -> Self {
Self::new()
}
}
impl Deref for Map {
type Target = HashMap<String, String>;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for Map {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
impl fmt::Display for Map {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let len = self.0.len();
for (i, (key, value)) in self.0.iter().enumerate() {
write!(f, "{}=\"{}\"", key, value)?;
if i + 1 < len {
write!(f, ",")?;
}
}
Ok(())
}
}
impl FromStr for Map {
type Err = &'static str;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let mut map = HashMap::new();
let mut s = s.trim();
while !s.is_empty() {
let (key, tail) = s.split_once('=').ok_or("Missing = after key")?;
let key = key.trim();
if !key.starts_with(char::is_alphabetic) {
return Err("Key must start with alphabetic character");
}
let tail = tail.trim_start();
let (value, tail) = match tail.strip_prefix('"') {
Some(tail) => {
let (value, tail) =
tail.split_once('"').ok_or("Missing closing \" for value")?;
let tail = tail.strip_prefix(',').unwrap_or(tail);
(value, tail)
}
None => match tail.split_once(',') {
Some((value, tail)) => (value.trim(), tail),
None => (tail.trim(), ""),
},
};
map.insert(key.to_string(), value.to_string());
s = tail.trim();
}
Ok(Self(map))
}
}
impl Serialize for Map {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serialize_to_str(self, serializer)
}
}
impl<'de> Deserialize<'de> for Map {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
deserialize_from_str(deserializer)
}
}
#[macro_export]
macro_rules! map {
($($key:literal -> $value:literal),*) => {{
let mut _map = ::std::collections::HashMap::new();
$(
_map.insert($key.to_string(), $value.to_string());
)*
$crate::Map::from(_map)
}};
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn should_support_being_parsed_from_str() {
let map = " ".parse::<Map>().unwrap();
assert_eq!(map, map!());
let map = "key=value".parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> "value"));
let map = "key.with-characters@=value".parse::<Map>().unwrap();
assert_eq!(map, map!("key.with-characters@" -> "value"));
let map = "key=value.has -@#$".parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> "value.has -@#$"));
let map = r#"key=",,,,""#.parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> ",,,,"));
let map = " key = value ".parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> "value"));
let map = r#" key = " value " "#.parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> " value "));
let map = "key=value,key2=value2".parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> "value", "key2" -> "value2"));
let map = r#"key="value one",key2=value2"#.parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> "value one", "key2" -> "value2"));
let map = r#"key=value,key2="value two""#.parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> "value", "key2" -> "value two"));
let map = r#"key="value one",key2="value two""#.parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> "value one", "key2" -> "value two"));
let map = r#"key="1,2,3",key2="4,5,6""#.parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> "1,2,3", "key2" -> "4,5,6"));
let map = "key=value,".parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> "value"));
let map = r#"key=",value,","#.parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> ",value,"));
let map = "key=value key2=value2".parse::<Map>().unwrap();
assert_eq!(map, map!("key" -> "value key2=value2"));
let _ = ",".parse::<Map>().unwrap_err();
let _ = ",key=value".parse::<Map>().unwrap_err();
let _ = "key=value,key2".parse::<Map>().unwrap_err();
}
#[test]
fn should_support_being_displayed_as_a_string() {
let map = map!().to_string();
assert_eq!(map, "");
let map = map!("key" -> "value").to_string();
assert_eq!(map, r#"key="value""#);
let map = map!("key" -> "value", "key2" -> "value2").to_string();
assert!(
map == r#"key="value",key2="value2""# || map == r#"key2="value2",key="value""#,
"{:?}",
map
);
let map = map!("key" -> ",", "key2" -> ",,").to_string();
assert!(
map == r#"key=",",key2=",,""# || map == r#"key2=",,",key=",""#,
"{:?}",
map
);
}
}