tfhe-versionable 0.8.0

tfhe-versionable: Add versioning informations/backward compatibility on rust types used for serialization
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
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

//! The simple example, with manual implementation of the versionize trait

use std::convert::Infallible;

use serde::{Deserialize, Serialize};
use tfhe_versionable::{Unversionize, UnversionizeError, Upgrade, Versionize, VersionizeOwned};

struct MyStruct<T> {
    attr: T,
    builtin: u32,
}

#[derive(Serialize, Deserialize)]
struct MyStructV0 {
    builtin: u32,
}

impl<T: Default> Upgrade<MyStruct<T>> for MyStructV0 {
    type Error = Infallible;

    fn upgrade(self) -> Result<MyStruct<T>, Self::Error> {
        Ok(MyStruct {
            attr: T::default(),
            builtin: self.builtin,
        })
    }
}

#[derive(Serialize)]
struct MyStructVersion<'vers, T: 'vers + Versionize> {
    attr: T::Versioned<'vers>,
    builtin: u32,
}

#[derive(Serialize, Deserialize)]
struct MyStructVersionOwned<T: VersionizeOwned> {
    attr: T::VersionedOwned,
    builtin: u32,
}

impl<T: Versionize + Serialize> Versionize for MyStruct<T> {
    type Versioned<'vers>
        = MyStructVersionsDispatch<'vers, T>
    where
        Self: 'vers;

    fn versionize(&self) -> Self::Versioned<'_> {
        let ver = MyStructVersion {
            attr: self.attr.versionize(),
            builtin: self.builtin,
        };
        MyStructVersionsDispatch::V1(ver)
    }
}

impl<T: VersionizeOwned + Serialize + for<'de> Deserialize<'de>> VersionizeOwned for MyStruct<T> {
    type VersionedOwned = MyStructVersionsDispatchOwned<T>;

    fn versionize_owned(self) -> Self::VersionedOwned {
        let ver = MyStructVersionOwned {
            attr: self.attr.versionize_owned(),
            builtin: self.builtin,
        };
        MyStructVersionsDispatchOwned::V1(ver)
    }
}

impl<T: Unversionize + Serialize + for<'de> Deserialize<'de> + Default> Unversionize
    for MyStruct<T>
{
    fn unversionize(versioned: Self::VersionedOwned) -> Result<Self, UnversionizeError> {
        match versioned {
            MyStructVersionsDispatchOwned::V0(v0) => v0
                .upgrade()
                .map_err(|e| UnversionizeError::upgrade("V0", "V1", e)),
            MyStructVersionsDispatchOwned::V1(v1) => Ok(Self {
                attr: T::unversionize(v1.attr)?,
                builtin: v1.builtin,
            }),
        }
    }
}

// Since MyStructV0 is only composed of built-in types, it does not need recursive versioning and
// can be used as its own "version type".
#[derive(Serialize)]
enum MyStructVersionsDispatch<'vers, T: 'vers + Versionize> {
    #[allow(dead_code)]
    V0(MyStructV0),
    #[allow(dead_code)]
    V1(MyStructVersion<'vers, T>),
}

#[derive(Serialize, Deserialize)]
enum MyStructVersionsDispatchOwned<T: VersionizeOwned> {
    V0(MyStructV0),
    V1(MyStructVersionOwned<T>),
}

mod v0 {
    use serde::{Deserialize, Serialize};
    use tfhe_versionable::{Unversionize, UnversionizeError, Versionize, VersionizeOwned};

    #[derive(Serialize, Deserialize)]
    pub(super) struct MyStruct {
        pub(super) builtin: u32,
    }

    impl Versionize for MyStruct {
        type Versioned<'vers> = MyStructVersionsDispatch;

        fn versionize(&self) -> Self::Versioned<'_> {
            let ver = MyStruct {
                builtin: self.builtin,
            };
            MyStructVersionsDispatch::V0(ver)
        }
    }

    impl VersionizeOwned for MyStruct {
        type VersionedOwned = MyStructVersionsDispatchOwned;

        fn versionize_owned(self) -> Self::VersionedOwned {
            MyStructVersionsDispatchOwned::V0(self)
        }
    }

    impl Unversionize for MyStruct {
        fn unversionize(versioned: Self::VersionedOwned) -> Result<Self, UnversionizeError> {
            match versioned {
                MyStructVersionsDispatchOwned::V0(v0) => Ok(v0),
            }
        }
    }

    #[derive(Serialize)]
    #[allow(dead_code)]
    pub(super) enum MyStructVersionsDispatch {
        V0(MyStruct),
    }

    #[derive(Serialize, Deserialize)]
    pub(super) enum MyStructVersionsDispatchOwned {
        V0(MyStruct),
    }
}

fn main() {
    let value = 1234;
    let ms = v0::MyStruct { builtin: value };

    let serialized = bincode::serialize(&ms.versionize()).unwrap();

    let unserialized =
        MyStruct::<u64>::unversionize(bincode::deserialize(&serialized).unwrap()).unwrap();

    assert_eq!(unserialized.builtin, value);
    assert_eq!(unserialized.attr, u64::default());
}

#[test]
fn test() {
    main()
}