rkyv 0.8.16

Zero-copy deserialization framework for Rust
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

use core::hint::unreachable_unchecked;

use munge::munge;
use rancor::Fallible;

use crate::{
    result::ArchivedResult, traits::NoUndef, Archive, Deserialize, Place,
    Serialize,
};

#[allow(dead_code)]
#[repr(u8)]
enum ArchivedResultTag {
    Ok,
    Err,
}

// SAFETY: `ArchivedResultTag` is `repr(u8)` and so always consists of a single
// well-defined byte.
unsafe impl NoUndef for ArchivedResultTag {}

#[repr(C)]
struct ArchivedResultVariantOk<T>(ArchivedResultTag, T);

#[repr(C)]
struct ArchivedResultVariantErr<U>(ArchivedResultTag, U);

impl<T: Archive, U: Archive> Archive for Result<T, U> {
    type Archived = ArchivedResult<T::Archived, U::Archived>;
    type Resolver = Result<T::Resolver, U::Resolver>;

    fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>) {
        match resolver {
            Ok(resolver) => {
                let out = unsafe {
                    out.cast_unchecked::<ArchivedResultVariantOk<T::Archived>>()
                };
                munge!(let ArchivedResultVariantOk(tag, out_value) = out);
                tag.write(ArchivedResultTag::Ok);

                match self.as_ref() {
                    Ok(value) => value.resolve(resolver, out_value),
                    Err(_) => unsafe { unreachable_unchecked() },
                }
            }
            Err(resolver) => {
                let out = unsafe {
                    out.cast_unchecked::<ArchivedResultVariantErr<U::Archived>>(
                    )
                };
                munge!(let ArchivedResultVariantErr(tag, out_err) = out);
                tag.write(ArchivedResultTag::Err);

                match self.as_ref() {
                    Ok(_) => unsafe { unreachable_unchecked() },
                    Err(err) => err.resolve(resolver, out_err),
                }
            }
        }
    }
}

impl<T, U, S> Serialize<S> for Result<T, U>
where
    T: Serialize<S>,
    U: Serialize<S>,
    S: Fallible + ?Sized,
{
    fn serialize(
        &self,
        serializer: &mut S,
    ) -> Result<Self::Resolver, S::Error> {
        Ok(match self.as_ref() {
            Ok(value) => Ok(value.serialize(serializer)?),
            Err(value) => Err(value.serialize(serializer)?),
        })
    }
}

impl<T, U, D> Deserialize<Result<T, U>, D>
    for ArchivedResult<T::Archived, U::Archived>
where
    T: Archive,
    U: Archive,
    D: Fallible + ?Sized,
    T::Archived: Deserialize<T, D>,
    U::Archived: Deserialize<U, D>,
{
    fn deserialize(
        &self,
        deserializer: &mut D,
    ) -> Result<Result<T, U>, D::Error> {
        match self {
            ArchivedResult::Ok(value) => {
                Ok(Ok(value.deserialize(deserializer)?))
            }
            ArchivedResult::Err(err) => Ok(Err(err.deserialize(deserializer)?)),
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::api::test::roundtrip;

    #[test]
    fn roundtrip_result() {
        roundtrip(&Result::<i32, u32>::Ok(12345i32));
        roundtrip(&Result::<i32, u32>::Err(12345u32));
    }
}