intrex 0.2.0

Intrusive collections with items addressed by indices
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use core::cmp::Ordering;

/// Read access for binary tree link fields.
pub trait NodesLink<Index> {
    /// Get the parent of a node.
    fn node_parent(&self, node: Index) -> Option<Index>;

    /// Get the left child of a node.
    fn node_left(&self, node: Index) -> Option<Index>;

    /// Get the right child of a node.
    fn node_right(&self, node: Index) -> Option<Index>;
}

/// Forwarding implementation
impl<T, Index> NodesLink<Index> for &T
where
    T: ?Sized + NodesLink<Index>,
{
    #[inline]
    #[track_caller]
    fn node_parent(&self, node: Index) -> Option<Index> {
        (**self).node_parent(node)
    }

    #[inline]
    #[track_caller]
    fn node_left(&self, node: Index) -> Option<Index> {
        (**self).node_left(node)
    }

    #[inline]
    #[track_caller]
    fn node_right(&self, node: Index) -> Option<Index> {
        (**self).node_right(node)
    }
}

/// Forwarding implementation
impl<T, Index> NodesLink<Index> for &mut T
where
    T: ?Sized + NodesLink<Index>,
{
    #[inline]
    #[track_caller]
    fn node_parent(&self, node: Index) -> Option<Index> {
        (**self).node_parent(node)
    }

    #[inline]
    #[track_caller]
    fn node_left(&self, node: Index) -> Option<Index> {
        (**self).node_left(node)
    }

    #[inline]
    #[track_caller]
    fn node_right(&self, node: Index) -> Option<Index> {
        (**self).node_right(node)
    }
}

/// Write access for binary tree link fields.
pub trait NodesLinkMut<Index>: NodesLink<Index> {
    /// Set the parent of a node.
    fn set_node_parent(&mut self, node: Index, parent: Option<Index>);

    /// Set the left child of a node.
    fn set_node_left(&mut self, node: Index, left: Option<Index>);

    /// Set the right child of a node.
    fn set_node_right(&mut self, node: Index, right: Option<Index>);
}

/// Forwarding implementation
impl<T, Index> NodesLinkMut<Index> for &mut T
where
    T: ?Sized + NodesLinkMut<Index>,
{
    #[inline]
    #[track_caller]
    fn set_node_parent(&mut self, node: Index, parent: Option<Index>) {
        (**self).set_node_parent(node, parent)
    }

    #[inline]
    #[track_caller]
    fn set_node_left(&mut self, node: Index, left: Option<Index>) {
        (**self).set_node_left(node, left)
    }

    #[inline]
    #[track_caller]
    fn set_node_right(&mut self, node: Index, right: Option<Index>) {
        (**self).set_node_right(node, right)
    }
}

/// Compare two nodes by their stored keys.
pub trait NodesCmp<Index> {
    /// Compare two nodes by their stored keys
    /// ([`Ord::cmp`]`(lhs.key, rhs.key)`).
    fn cmp_nodes(&self, lhs: Index, rhs: Index) -> Ordering;
}

/// Forwarding implementation
impl<T, Index> NodesCmp<Index> for &T
where
    T: ?Sized + NodesCmp<Index>,
{
    #[inline]
    #[track_caller]
    fn cmp_nodes(&self, lhs: Index, rhs: Index) -> Ordering {
        (**self).cmp_nodes(lhs, rhs)
    }
}

/// Forwarding implementation
impl<T, Index> NodesCmp<Index> for &mut T
where
    T: ?Sized + NodesCmp<Index>,
{
    #[inline]
    #[track_caller]
    fn cmp_nodes(&self, lhs: Index, rhs: Index) -> Ordering {
        (**self).cmp_nodes(lhs, rhs)
    }
}

/// Compare a node against a given search key.
pub trait NodesCmpKey<Index, Key> {
    /// Compare a node's key against a given search key
    /// ([`Ord::cmp`]`(node.key, key)`).
    fn cmp_node_key(&self, node: Index, key: &Key) -> Ordering;
}

/// Forwarding implementation
impl<T, Index, Key> NodesCmpKey<Index, Key> for &T
where
    T: ?Sized + NodesCmpKey<Index, Key>,
{
    #[inline]
    #[track_caller]
    fn cmp_node_key(&self, node: Index, key: &Key) -> Ordering {
        (**self).cmp_node_key(node, key)
    }
}

/// Forwarding implementation
impl<T, Index, Key> NodesCmpKey<Index, Key> for &mut T
where
    T: ?Sized + NodesCmpKey<Index, Key>,
{
    #[inline]
    #[track_caller]
    fn cmp_node_key(&self, node: Index, key: &Key) -> Ordering {
        (**self).cmp_node_key(node, key)
    }
}