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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
#![allow(clippy::needless_doctest_main)]
#![feature(specialization)]
#[cfg(feature = "serde_version_derive")]
#[allow(unused_imports)]
#[macro_use]
extern crate serde_version_derive;
#[cfg(feature = "serde_version_derive")]
#[doc(hidden)]
pub use serde_version_derive::*;
#[allow(unused_imports)]
#[macro_use]
extern crate lazy_static;
#[doc(hidden)]
pub use lazy_static::*;
#[macro_use]
extern crate failure;
#[cfg(test)]
extern crate quickcheck;
#[cfg(test)]
#[macro_use(quickcheck)]
extern crate quickcheck_macros;
mod deserializer;
mod seed;
mod version_groups;
mod version_map;
mod visitor;
#[macro_use]
mod utils;
pub mod exports;
#[cfg(feature = "toml-support")]
pub mod toml;
pub use deserializer::VersionedDeserializer;
use serde::de::{EnumAccess, MapAccess, SeqAccess};
use std::fmt::Display;
pub use version_groups::{
DefaultVersionGroupResolver, VersionGroupResolver, VersionGroupURI, VersionGroupURIs,
};
pub use version_map::{
AggregateVersionMap, AggregateVersionMapError, DefaultVersionMap, TypeInMultipleVersionGroups,
UnknownVersionURI, VersionMap,
};
#[derive(Debug, Hash, PartialEq, Eq, Fail)]
#[fail(display = "Unknown version {} for type {}", version, type_id)]
pub struct InvalidVersionError {
pub version: usize,
pub type_id: String,
}
#[derive(Debug, Hash, PartialEq, Eq)]
pub enum Error<E> {
DeserializeError(E),
InvalidVersionError(InvalidVersionError),
Message(String),
}
impl<E> Error<E>
where
E: serde::de::Error,
{
pub fn into_error(self) -> E {
match self {
Error::Message(err) => serde::de::Error::custom(err),
Error::DeserializeError(err) => err,
Error::InvalidVersionError(err) => serde::de::Error::custom(format!("{}", err)),
}
}
}
impl<E> Error<Error<E>>
where
E: serde::de::Error,
{
pub fn reduce(self) -> Error<E> {
match self {
Error::Message(err) | Error::DeserializeError(Error::Message(err)) => {
Error::Message(err)
}
Error::InvalidVersionError(err)
| Error::DeserializeError(Error::InvalidVersionError(err)) => {
Error::InvalidVersionError(err)
}
Error::DeserializeError(Error::DeserializeError(err)) => Error::DeserializeError(err),
}
}
}
impl<E> std::fmt::Display for Error<E>
where
E: std::fmt::Display,
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
match self {
Error::DeserializeError(ref e) => write!(f, "{}", e),
Error::InvalidVersionError(ref e) => {
write!(f, "Unknown version {} for type {}", e.version, e.type_id)
}
Error::Message(ref e) => write!(f, "{}", e),
}
}
}
impl<E> std::error::Error for Error<E> where E: std::error::Error {}
impl<E> serde::de::Error for Error<E>
where
E: serde::de::Error,
{
fn custom<T>(msg: T) -> Self
where
T: Display,
{
Self::Message(format!("{}", msg))
}
}
pub trait DeserializeVersioned<'de, VM: VersionMap>: serde::Deserialize<'de> {
fn deserialize_versioned<D>(deserializer: D, _version_map: VM) -> Result<Self, Error<D::Error>>
where
D: serde::de::Deserializer<'de>;
fn next_element<S>(
seq_access: &mut S,
version_map: VM,
) -> Result<Option<Self>, Error<S::Error>>
where
S: SeqAccess<'de>;
fn next_value<M>(map_access: &mut M, _version_map: VM) -> Result<Self, Error<M::Error>>
where
M: MapAccess<'de>;
fn next_key<M>(map_access: &mut M, _version_map: VM) -> Result<Option<Self>, Error<M::Error>>
where
M: MapAccess<'de>;
fn variant<E>(enum_access: E, _version_map: VM) -> Result<(Self, E::Variant), Error<E::Error>>
where
E: EnumAccess<'de>;
}
impl<'de, T: serde::Deserialize<'de>, VM: VersionMap> DeserializeVersioned<'de, VM> for T {
default fn deserialize_versioned<D>(
deserializer: D,
version_map: VM,
) -> Result<Self, Error<D::Error>>
where
D: serde::de::Deserializer<'de>,
{
let version_deserializer = VersionedDeserializer::new(deserializer, version_map);
T::deserialize(version_deserializer)
}
#[inline]
default fn next_element<S>(
seq_access: &mut S,
_version_map: VM,
) -> Result<Option<Self>, Error<S::Error>>
where
S: SeqAccess<'de>,
{
seq_access
.next_element_seed(std::marker::PhantomData)
.map_err(Error::DeserializeError)
}
#[inline]
default fn next_value<M>(map_access: &mut M, _version_map: VM) -> Result<Self, Error<M::Error>>
where
M: MapAccess<'de>,
{
map_access
.next_value_seed(std::marker::PhantomData)
.map_err(Error::DeserializeError)
}
#[inline]
default fn next_key<M>(
map_access: &mut M,
_version_map: VM,
) -> Result<Option<Self>, Error<M::Error>>
where
M: MapAccess<'de>,
{
map_access
.next_key_seed(std::marker::PhantomData)
.map_err(Error::DeserializeError)
}
#[inline]
default fn variant<E>(
enum_access: E,
_version_map: VM,
) -> Result<(Self, E::Variant), Error<E::Error>>
where
E: EnumAccess<'de>,
{
enum_access
.variant_seed(std::marker::PhantomData)
.map_err(Error::DeserializeError)
}
}