ivy-resources 0.10.3

Handle based resource management and shared state
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

use slotmap::new_key_type;
pub use slotmap::{Key, KeyData};
use std::hash::Hash;
use std::marker::PhantomData;

pub struct Handle<T>(KeyData, PhantomData<T>);

impl<T> Handle<T> {
    /// Creates a new handle that is always invalid and distinct from any non-null
    /// handle. A null key can only be created through this method (or default
    /// initialization of handles made with `new_key_type!`, which calls this
    /// method).
    ///
    /// A null handle is always invalid, but an invalid key (that is, a key that
    /// has been removed from the slot map) does not become a null handle. A null
    /// is safe to use with any safe method of any slot map instance.
    pub fn null() -> Self {
        Key::null()
    }

    /// Checks if a handle is null. There is only a single null key, that is
    /// `a.is_null() && b.is_null()` implies `a == b`.
    pub fn is_null(&self) -> bool {
        Key::is_null(self)
    }

    /// Removes the type from a handle, easier storage without using dynamic
    /// dispatch
    pub fn into_untyped(&self) -> HandleUntyped {
        HandleUntyped(self.data())
    }

    /// Converts an untyped handle into a typed handle.
    /// Behaviour is undefined if handle is converted back to the wrong type.
    /// Use with care.
    pub fn from_untyped(handle: HandleUntyped) -> Handle<T> {
        Self(handle.data(), PhantomData)
    }
}

new_key_type!(
    pub struct HandleUntyped;
);

unsafe impl<T> Key for Handle<T> {
    fn data(&self) -> KeyData {
        self.0
    }
}

impl<T> PartialOrd for Handle<T> {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.0.cmp(&other.0))
    }
}

impl<T> Ord for Handle<T> {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.0.cmp(&other.0)
    }
}

impl<T> Default for Handle<T> {
    fn default() -> Self {
        Self(KeyData::default(), PhantomData)
    }
}

impl<T> std::fmt::Debug for Handle<T> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{:?}", self.0)
    }
}

impl<T> Clone for Handle<T> {
    fn clone(&self) -> Self {
        Self(self.0, PhantomData)
    }
}

impl<T> Copy for Handle<T> {}

impl<T> PartialEq for Handle<T> {
    fn eq(&self, other: &Self) -> bool {
        self.0 == other.0
    }
}

impl<T> Eq for Handle<T> {}

impl<T> Hash for Handle<T> {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.0.hash(state)
    }
}

impl<T> From<KeyData> for Handle<T> {
    fn from(k: KeyData) -> Self {
        Self(k, PhantomData)
    }
}