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

use core::fmt::Debug;

use bytecheck::CheckBytes;
use rancor::Panic;

#[cfg(feature = "alloc")]
use crate::api::high::{access_mut, HighValidator as TestValidator};
#[cfg(not(feature = "alloc"))]
use crate::api::low::{access_mut, LowValidator as TestValidator};
use crate::{
    api::test::{deserialize, to_bytes, TestDeserializer, TestSerializer},
    seal::Seal,
    Archive, Deserialize, Serialize,
};

/// Serializes the given type to bytes, accesses the archived version, and calls
/// the given function with it.
pub fn to_archived<T>(value: &T, f: impl FnOnce(Seal<'_, T::Archived>))
where
    T: for<'a> Serialize<TestSerializer<'a>>,
    T::Archived: for<'a> CheckBytes<TestValidator<'a, Panic>>,
{
    to_bytes(value, |bytes| to_archived_from_bytes::<T>(bytes, f));
}

/// Accesses the archived version and calls the given function with it.
pub fn to_archived_from_bytes<T>(
    bytes: &mut [u8],
    f: impl FnOnce(Seal<'_, T::Archived>),
) where
    T: Archive,
    T::Archived: for<'a> CheckBytes<TestValidator<'a, Panic>>,
{
    let archived_value = access_mut::<T::Archived, Panic>(bytes).unwrap();
    f(archived_value);
}

/// Serializes and deserializes the given value, checking for equality with the
/// archived and deserialized values using the given comparison function.
pub fn roundtrip_with<T>(value: &T, cmp: impl Fn(&T, &T::Archived))
where
    T: Debug + PartialEq + for<'a> Serialize<TestSerializer<'a>>,
    T::Archived: Debug
        + Deserialize<T, TestDeserializer>
        + for<'a> CheckBytes<TestValidator<'a, Panic>>,
{
    to_archived(value, |archived_value| {
        cmp(value, &*archived_value);
        let deserialized = deserialize::<T>(&*archived_value);
        assert_eq!(value, &deserialized);
    });
}

/// Serializes and deserializes the given value, checking for equality with the
/// archived and deserialized values.
pub fn roundtrip<T>(value: &T)
where
    T: Debug + PartialEq + for<'a> Serialize<TestSerializer<'a>>,
    T::Archived: Debug
        + PartialEq<T>
        + Deserialize<T, TestDeserializer>
        + for<'a> CheckBytes<TestValidator<'a, Panic>>,
{
    roundtrip_with(value, |a, b| assert_eq!(b, a));
}