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
use std::collections::HashMap;
use serde::{de::DeserializeOwned, Deserialize, Deserializer};
/// Deserialize an array of objects where each object is nested
/// under a key indicating its type.
///
/// Hetzner's Robot API does not return naked objects, but
/// instead encapsulates each in a single key-value pair
/// indicating the type of the object.
///
/// For example, listing all `servers` with the Robot API does
/// not produce an array of servers, but instead an array
/// of objects with a single key-value pair of:
///
/// `[ {"server": <ServerObject>}, ... ]`.
///
/// In order to transform this result, it is necessary to first
/// deserialize the outer map, and then extract the contained
/// server objects.
pub(crate) fn deserialize_inner_vec<'de, T: Deserialize<'de>, D: Deserializer<'de>>(
deserializer: D,
) -> Result<Vec<T>, D::Error> {
let tmp = Vec::<HashMap<&str, T>>::deserialize(deserializer)?;
tmp.into_iter()
.map(|map| {
map.into_values()
.next()
.ok_or(serde::de::Error::custom("empty map"))
})
.try_fold(Vec::new(), |mut acc, result| {
acc.push(result?);
Ok(acc)
})
}
/// Deserialize a Map of `{"object_name": <Object> }` into [`Vec<Object>`].
///
/// Hetzner's Robot API does not return naked objects, but
/// instead encapsulates each in a single key-value pair
/// indicating the type of the object.
///
/// For example, retrieving a `server` with the Robot API does
/// not produce a server objects, but instead an objects with
/// a single key-value pair of:
///
/// `{"server": <ServerObject>}`.
///
/// In order to transform this result, it is necessary to first
/// deserialize the outer map, and then extract the contained
/// server objects.
fn deserialize_inner<'de, T: Deserialize<'de>, D: Deserializer<'de>>(
deserializer: D,
) -> Result<T, D::Error> {
HashMap::<&str, T>::deserialize(deserializer)?
.into_values()
.next()
.ok_or(serde::de::Error::custom("empty map"))
}
/// Deserialize a list of [`T`], where each T is wrapped.
#[derive(Debug, Deserialize)]
pub struct List<T: DeserializeOwned>(
#[serde(deserialize_with = "deserialize_inner_vec")] pub Vec<T>,
);
/// Deserialize a single wrapped [`T`].
#[derive(Debug, Deserialize)]
pub struct Single<T: DeserializeOwned>(#[serde(deserialize_with = "deserialize_inner")] pub T);
/// Some endpoints don't return anything.
///
/// This type always deserializes correctly and unlike () succeeds
/// even if the input is empty.
#[derive(Debug)]
pub struct Empty;
impl Empty {
/// Used to explicitly throwaway an empty result, to satisfy the unused_result lint.
pub fn throw_away(self) {}
}
impl<'de> Deserialize<'de> for Empty {
fn deserialize<D>(_: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
// It's safe to always return true, because even when the
// response body actually contains an error, this deserialization
// will ultimately fail with a "trailing characters" error,
// meaning we only *actually* succeed on truly empty input.
Ok(Empty)
}
}
#[cfg(test)]
mod tests {
use serde::Deserialize;
use crate::api::server::Server;
use super::Empty;
#[test]
fn deserialize_wrapped() {
let json = r#"{
"server": {
"server_ip":"1.1.1.1",
"server_ipv6_net":"2a01:4f8:1::",
"server_number":2000001,
"server_name":"n1",
"product":"Server Auction",
"dc":"FSN1-DC1",
"traffic":"unlimited",
"status":"ready",
"cancelled":false,
"paid_until":"2070-01-01","ip":["1.1.1.1"],
"subnet":[
{"ip":"2a01:4f8:1::","mask":"64"}
],
"linked_storagebox":null
}
}"#;
#[derive(Debug, Deserialize)]
struct UnwrappingSingleServer {
#[serde(deserialize_with = "crate::api::wrapper::deserialize_inner", flatten)]
server: Server,
}
let UnwrappingSingleServer { server } = serde_json::from_str(json).unwrap();
println!("{server:#?}");
}
#[test]
fn deserialize_wrapped_vec() {
let json = r#"[
{
"server":{"server_ip":"1.1.1.1",
"server_ipv6_net":"2a01:4f8:1::",
"server_number":2000001,
"server_name":"n1",
"product":"Server Auction",
"dc":"FSN1-DC1",
"traffic":"unlimited",
"status":"ready",
"cancelled":false,
"paid_until":"2070-01-01",
"ip":["1.1.1.1"],
"subnet":[
{
"ip":"2a01:4f8:1::",
"mask":"64"
}
],
"linked_storagebox":null
}
},
{
"server":{
"server_ip":"2.2.2.2",
"server_ipv6_net":"2a01:4f8:2::",
"server_number":2000002,
"server_name":"n2",
"product":"Server Auction",
"dc":"FSN1-DC2",
"traffic":"unlimited",
"status":"ready",
"cancelled":false,
"paid_until":"2070-01-01",
"ip":["2.2.2.2"],
"subnet":[
{
"ip":"2a01:4f8:2::",
"mask":"64"
}
],
"linked_storagebox":null
}
},
{
"server":{
"server_ip":"3.3.3.3",
"server_ipv6_net":"2a01:4f8:3::",
"server_number":2000003,
"server_name":"n3",
"product":"Server Auction",
"dc":"FSN1-DC3",
"traffic":"unlimited",
"status":"ready",
"cancelled":false,
"paid_until":"2070-01-01",
"ip":["3.3.3.3"],
"subnet": [
{
"ip":"2a01:4f8:3::",
"mask":"64"
}
],
"linked_storagebox":null
}
}
]"#;
#[derive(Debug, Deserialize)]
struct UnwrappingManyServers(
#[serde(deserialize_with = "crate::api::wrapper::deserialize_inner_vec")] Vec<Server>,
);
let UnwrappingManyServers(servers) = serde_json::from_str(json).unwrap();
println!("{servers:#?}");
}
#[test]
fn deserialize_empty_response() {
let response = "";
let _empty: Empty = serde_json::from_str(response).unwrap();
}
#[test]
fn deserialize_nonempty_response() {
let response = r#"{
"error": "hello"
}"#;
let _err = serde_json::from_str::<Empty>(response).unwrap_err();
}
}