panoradix 0.6.8

A generic map and a set, both backed by a Radix tree.
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

pub trait KeyComponent: Ord + Eq + Clone {}
impl<T: Ord + Eq + Clone> KeyComponent for T {}

pub trait Key: ToOwned {
    type Component: KeyComponent;

    fn as_slice(&self) -> &[Self::Component];

    fn from_vec(v: Vec<Self::Component>) -> Self::Owned;
}

impl Key for str {
    type Component = u8;

    fn as_slice(&self) -> &[u8] {
        self.as_bytes()
    }

    fn from_vec(v: Vec<u8>) -> String {
        unsafe {
            String::from_utf8_unchecked(v)
        }
    }
}

impl<T: KeyComponent> Key for [T] {
    type Component = T;

    fn as_slice(&self) -> &[T] {
        self
    }

    fn from_vec(v: Vec<T>) -> Vec<T> {
        v
    }
}

/// A key that can be inserted in both [`RadixSet`] and [`RadixMap`].
///
/// These keys should be equivalent to slices of `T: Ord + Eq + Clone`.
///
/// [`RadixSet`]: set/struct.RadixSet.html
/// [`RadixMap`]: map/struct.RadixMap.html
pub trait ExtensibleKey: ToOwned {
    /// A single component of the key. Note that it should be `Ord + Eq + Clone`.
    type Component: KeyComponent;

    /// Get a slice of key components to integrate the key in a radix tree.
    fn as_slice(&self) -> &[Self::Component];

    /// Given a merged vec of components, build an owned.
    fn from_vec(v: Vec<Self::Component>) -> Self::Owned;
}

impl<T: ExtensibleKey> Key for T {
    type Component = T::Component;

    fn as_slice(&self) -> &[Self::Component] {
        self.as_slice()
    }

    fn from_vec(v: Vec<Self::Component>) -> Self::Owned {
        T::from_vec(v)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn it_can_be_extended() {
        #[derive(Clone)]
        struct Wrapper(Vec<()>);

        impl ExtensibleKey for Wrapper {
            type Component = ();

            fn as_slice<'a>(&'a self) -> &'a [()] {
                &self.0
            }

            fn from_vec(v: Vec<Self::Component>) -> Self::Owned {
                Wrapper(v)
            }
        }

        use set::RadixSet;

        let mut s = RadixSet::<Wrapper>::new();
        s.insert(&Wrapper(vec![()]));
    }
}