geiserx_ts_bart 0.27.0

fast, memory-efficient routing table
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 alloc::boxed::Box;

/// Generic data storage mechanism.
///
/// Currently an abstraction over [`Box`] storage (much more memory-efficient)
/// and inlined structs (sometimes faster).
///
/// The particular structure of the trait (GAT for container type) is needed to
/// enable the storage type to not carry a parameter, e.g. `Node<T,
/// InlineStorage>` (rather than `Node<T, InlineStorage<T>>`). This is desirable
/// to make type inference and trait derivation much more straightforward.
pub trait Storage {
    /// The container type used to hold the value type.
    type Container<T>;

    /// Construct a new container.
    fn new<T>(t: T) -> Self::Container<T>;
    /// Destruct the container to retrieve the contained value.
    fn into_inner<T>(container: Self::Container<T>) -> T;
    /// Retrieve a reference to the contained value.
    fn as_ref<T>(container: &Self::Container<T>) -> &T;
    /// Retrieve a mutable reference to the contained value.
    fn as_mut<T>(container: &mut Self::Container<T>) -> &mut T;
    /// Clone the container.
    fn clone<T>(container: &Self::Container<T>) -> Self::Container<T>
    where
        T: Clone;
}

/// [`Storage`] that stores values inline.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum InlineStorage {}

/// [`Storage`] that stores values in boxes.
///
/// # Memory Efficiency
///
/// Vastly more memory-efficient than inline storage: `heaptrack` suggests on the order of 5x
/// better.
///
/// Notably, `size_of::<Box<T>>()` is always a single `usize`, while an inline `Node` is 2
/// `Array256`es, which are comparatively large (256-bit bitset + vec -> ~7x larger up to alignment
/// on a 64-bit arch). Suspect the large overhead for inline storage is mostly due to the
/// powers-of-two oversizing of the `Node::children` Vec storage: this is going to be costly in
/// direct proportion to the size of the contained value.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum BoxStorage {}

impl Storage for InlineStorage {
    type Container<T> = T;

    #[inline]
    fn new<T>(t: T) -> Self::Container<T> {
        t
    }

    #[inline]
    fn into_inner<T>(container: Self::Container<T>) -> T {
        container
    }

    #[inline]
    fn as_ref<T>(container: &Self::Container<T>) -> &T {
        container
    }

    #[inline]
    fn as_mut<T>(container: &mut Self::Container<T>) -> &mut T {
        container
    }

    #[inline]
    fn clone<T>(container: &Self::Container<T>) -> Self::Container<T>
    where
        T: Clone,
    {
        container.clone()
    }
}

impl Storage for BoxStorage {
    type Container<T> = Box<T>;

    #[inline]
    fn new<T>(t: T) -> Self::Container<T> {
        Box::new(t)
    }

    #[inline]
    fn into_inner<T>(container: Self::Container<T>) -> T {
        *container
    }

    #[inline]
    fn as_ref<T>(container: &Self::Container<T>) -> &T {
        container.as_ref()
    }

    #[inline]
    fn as_mut<T>(container: &mut Self::Container<T>) -> &mut T {
        container.as_mut()
    }

    #[inline]
    fn clone<T>(container: &Self::Container<T>) -> Self::Container<T>
    where
        T: Clone,
    {
        container.clone()
    }
}