general_stable_vec 0.15.0

A Vec implementation with stable 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

//! An index type that is marked by a type.
//! This prevents to accidentally use a wrong value as the index for a stable vector.

use std::marker::PhantomData;

use crate::interface::StableVecIndex;

/// An index type that is marked by a type `Marker`.
/// This prevents to accidentally use a wrong value as the index for a stable vector.
#[derive(Debug)]
pub struct MarkedIndex<Marker> {
    index: usize,
    marker: PhantomData<Marker>,
}

impl<Marker> StableVecIndex for MarkedIndex<Marker> {}

impl<Marker> From<usize> for MarkedIndex<Marker> {
    fn from(index: usize) -> Self {
        Self {
            index,
            marker: Default::default(),
        }
    }
}

impl<Marker> From<MarkedIndex<Marker>> for usize {
    fn from(value: MarkedIndex<Marker>) -> Self {
        value.index
    }
}

impl<Marker> Clone for MarkedIndex<Marker> {
    fn clone(&self) -> Self {
        *self
    }
}

impl<Marker> Copy for MarkedIndex<Marker> {}

impl<Marker> PartialEq for MarkedIndex<Marker> {
    fn eq(&self, other: &Self) -> bool {
        self.index == other.index
    }
}

impl<Marker> Eq for MarkedIndex<Marker> {}

impl<Marker> PartialOrd for MarkedIndex<Marker> {
    fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl<Marker> Ord for MarkedIndex<Marker> {
    fn cmp(&self, other: &Self) -> core::cmp::Ordering {
        self.index.cmp(&other.index)
    }
}

impl<Marker> core::hash::Hash for MarkedIndex<Marker> {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.index.hash(state);
        self.marker.hash(state);
    }
}