rkyv_util 0.1.0-alpha.2

Tools for zero-copy deserialization with rkyv
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

//! Bindings for working with memory mapped objects in a cleaner way.

use memmap2_0_9::{Mmap, MmapMut};

use crate::owned::{StableBytes, StableBytesMut};

unsafe impl StableBytes for Mmap {
    fn bytes(&self) -> &[u8] {
        &*self
    }
}

unsafe impl StableBytes for MmapMut {
    fn bytes(&self) -> &[u8] {
        &*self
    }
}

unsafe impl StableBytesMut for MmapMut {
    fn bytes_mut(&mut self) -> &mut [u8] {
        &mut *self
    }
}

#[cfg(test)]
mod tests {
    use std::io::{Seek, SeekFrom, Write};

    use memmap2_0_9::{Mmap, MmapMut};
    use rkyv::{munge::munge, rancor, Archive, Deserialize, Serialize};

    use crate::owned::OwnedArchive;

    #[derive(Archive, Clone, PartialEq, Deserialize, Serialize, Debug)]
    #[rkyv(compare(PartialEq), derive(Debug))]
    pub struct Foo {
        hello: u8,
        world: u64,
    }

    #[test]
    fn test_owned_archive_vec_mmap() {
        let foo = Foo { hello: 4, world: 5 };

        let bytes = rkyv::to_bytes::<rancor::Error>(&foo).unwrap();

        let mut tfile = tempfile::tempfile().unwrap();

        tfile.write_all(&bytes).unwrap();
        tfile.seek(SeekFrom::Start(0)).unwrap();

        let mmap = unsafe { Mmap::map(&tfile) }.unwrap();

        let owned =
            OwnedArchive::<ArchivedFoo, _>::new::<rancor::Error>(mmap).unwrap();

        // Finally check to see that both are equal.
        assert_eq!(owned.hello, 4);
        assert_eq!(owned.world, 5);

        // Finally check to see that both are equal.
        assert_eq!(foo, *owned);
    }

    #[test]
    fn test_owned_archive_vec_mmap_mut() {
        let foo = Foo { hello: 4, world: 5 };

        let bytes = rkyv::to_bytes::<rancor::Error>(&foo).unwrap();

        let mut tfile = tempfile::tempfile().unwrap();

        tfile.write_all(&bytes).unwrap();
        tfile.seek(SeekFrom::Start(0)).unwrap();
        // write(tfile.path(), contents)

        let mmap = unsafe { MmapMut::map_mut(&tfile) }.unwrap();

        let mut owned =
            OwnedArchive::<ArchivedFoo, _>::new::<rancor::Error>(mmap).unwrap();

        // Finally check to see that both are equal.
        assert_eq!(owned.hello, 4);
        assert_eq!(owned.world, 5);

        // Finally check to see that both are equal.
        assert_eq!(foo, *owned);

        // Modify it
        munge!(let ArchivedFoo { mut hello, .. } = owned.get_mut());
        *hello = 3;
        assert_eq!(owned.hello, 3);
    }
}