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
112
113
114
115
116

use core::{error::Error, fmt, hash::BuildHasherDefault};

use hashbrown::hash_map::{Entry, HashMap};
use rancor::{fail, Source};

use crate::{
    de::pooling::{ErasedPtr, Pooling, PoolingState},
    hash::FxHasher64,
};

#[derive(Debug)]
struct SharedPointer {
    ptr: ErasedPtr,
    drop: unsafe fn(ErasedPtr),
}

impl Drop for SharedPointer {
    fn drop(&mut self) {
        unsafe {
            (self.drop)(self.ptr);
        }
    }
}

/// A shared pointer strategy that pools together deserializations of the same
/// shared pointer.
#[derive(Default)]
pub struct Pool {
    shared_pointers:
        HashMap<usize, Option<SharedPointer>, BuildHasherDefault<FxHasher64>>,
}

impl Pool {
    /// Creates a new shared pointer unifier.
    #[inline]
    pub fn new() -> Self {
        Self::default()
    }

    /// Creates a new shared pointer unifier with initial capacity.
    #[inline]
    pub fn with_capacity(capacity: usize) -> Self {
        Self {
            shared_pointers: HashMap::with_capacity_and_hasher(
                capacity,
                Default::default(),
            ),
        }
    }
}

impl fmt::Debug for Pool {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_map().entries(self.shared_pointers.iter()).finish()
    }
}

#[derive(Debug)]
struct NotStarted;

impl fmt::Display for NotStarted {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "shared pointer was not started pooling")
    }
}

impl Error for NotStarted {}

#[derive(Debug)]
struct AlreadyFinished;

impl fmt::Display for AlreadyFinished {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "shared pointer was already finished pooling")
    }
}

impl Error for AlreadyFinished {}

impl<E: Source> Pooling<E> for Pool {
    fn start_pooling(&mut self, address: usize) -> PoolingState {
        match self.shared_pointers.entry(address) {
            Entry::Vacant(vacant) => {
                vacant.insert(None);
                PoolingState::Started
            }
            Entry::Occupied(occupied) => {
                if let Some(shared) = occupied.get() {
                    PoolingState::Finished(shared.ptr)
                } else {
                    PoolingState::Pending
                }
            }
        }
    }

    unsafe fn finish_pooling(
        &mut self,
        address: usize,
        ptr: ErasedPtr,
        drop: unsafe fn(ErasedPtr),
    ) -> Result<(), E> {
        match self.shared_pointers.entry(address) {
            Entry::Vacant(_) => fail!(NotStarted),
            Entry::Occupied(mut occupied) => {
                let inner = occupied.get_mut();
                if inner.is_some() {
                    fail!(AlreadyFinished)
                } else {
                    *inner = Some(SharedPointer { ptr, drop });
                    Ok(())
                }
            }
        }
    }
}