id_sys 0.1.0

Provides data structures which can be marked such that they only work with similarly marked integer data types.
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186

use crate::{IdPtr, IsizeId, UsizeId};
use std::{
    cmp::Ordering,
    fmt::{self, Debug, Pointer},
    hash::{Hash, Hasher},
    marker::PhantomData,
    mem::transmute,
};

pub struct MutIdPtr<TMarker: ?Sized, TValue: ?Sized> {
    phantom: PhantomData<TMarker>,
    repr: *mut TValue,
}

impl<TMarker: ?Sized, TValue> MutIdPtr<TMarker, TValue> {
    /// # Safety
    /// See https://doc.rust-lang.org/std/primitive.pointer.html#method.add-1
    pub const unsafe fn add(self, count: UsizeId<TMarker>) -> MutIdPtr<TMarker, TValue> {
        MutIdPtr::from_mut_ptr(self.to_mut_ptr().add(count.to_usize()))
    }

    pub const fn cast_to<TValue2>(self) -> MutIdPtr<TMarker, TValue2> {
        MutIdPtr::from_mut_ptr(self.to_mut_ptr() as *mut TValue2)
    }

    /// # Safety
    /// The same rules apply as dereferencing a raw pointer.
    pub unsafe fn deref_ptr<'a>(self) -> &'a mut TValue {
        &mut *self.repr
    }

    /// # Safety
    /// The same rules apply as dereferencing a raw pointer.
    pub unsafe fn deref_ptr_mut<'a>(self) -> &'a mut TValue {
        &mut *self.repr
    }

    pub const fn from_mut_ptr(repr: *mut TValue) -> Self {
        Self {
            phantom: PhantomData,
            repr,
        }
    }

    /// # Safety
    /// See https://doc.rust-lang.org/std/primitive.pointer.html#method.offset-1
    pub const unsafe fn offset(self, offset: IsizeId<TMarker>) -> Self {
        Self::from_mut_ptr(self.to_mut_ptr().offset(offset.to_isize()))
    }

    /// # Safety
    /// See https://doc.rust-lang.org/std/primitive.pointer.html#method.read-1
    pub const unsafe fn read(self) -> TValue {
        self.to_mut_ptr().read()
    }

    /// # Safety
    /// See https://doc.rust-lang.org/std/primitive.pointer.html#method.read_unaligned-1
    pub const unsafe fn read_unaligned(self) -> TValue {
        self.to_mut_ptr().read_unaligned()
    }

    pub const fn to_id_ptr(self) -> IdPtr<TMarker, TValue> {
        IdPtr::from_ptr(self.to_mut_ptr())
    }

    pub const fn to_mut_ptr(self) -> *mut TValue {
        self.repr
    }

    /// # Safety
    /// See https://doc.rust-lang.org/std/primitive.pointer.html#method.write
    pub unsafe fn write(self, val: TValue) {
        self.to_mut_ptr().write(val)
    }

    /// # Safety
    /// See https://doc.rust-lang.org/std/primitive.pointer.html#method.write_unaligned
    pub unsafe fn write_unaligned(self, val: TValue) {
        self.to_mut_ptr().write_unaligned(val)
    }
}

impl<TMarker: ?Sized, TValue> Clone for MutIdPtr<TMarker, TValue> {
    fn clone(&self) -> Self {
        *self
    }
}

impl<TMarker: ?Sized, TValue> Copy for MutIdPtr<TMarker, TValue> {}

impl<TMarker: ?Sized, TValue> Debug for MutIdPtr<TMarker, TValue> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        Debug::fmt(&self.to_id_ptr(), f)
    }
}

impl<TMarker: ?Sized, TValue> Eq for MutIdPtr<TMarker, TValue> {}

impl<TMarker: ?Sized, TValue> From<*mut TValue> for MutIdPtr<TMarker, TValue> {
    fn from(value: *mut TValue) -> Self {
        Self::from_mut_ptr(value)
    }
}

impl<TMarker: ?Sized, TValue> Hash for MutIdPtr<TMarker, TValue> {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.to_mut_ptr().hash(state)
    }

    fn hash_slice<H>(data: &[Self], state: &mut H)
    where
        H: Hasher,
    {
        let data = unsafe { transmute(data) };
        <*mut TValue>::hash_slice(data, state)
    }
}

impl<TMarker: ?Sized, TValue> Ord for MutIdPtr<TMarker, TValue> {
    fn cmp(&self, other: &Self) -> Ordering {
        self.to_mut_ptr().cmp(&other.to_mut_ptr())
    }

    fn max(self, other: Self) -> Self
    where
        Self: Sized,
    {
        Self::from_mut_ptr(self.to_mut_ptr().max(other.to_mut_ptr()))
    }

    fn min(self, other: Self) -> Self
    where
        Self: Sized,
    {
        Self::from_mut_ptr(self.to_mut_ptr().min(other.to_mut_ptr()))
    }

    fn clamp(self, min: Self, max: Self) -> Self
    where
        Self: Sized,
        Self: PartialOrd,
    {
        Self::from_mut_ptr(self.to_mut_ptr().clamp(min.to_mut_ptr(), max.to_mut_ptr()))
    }
}

impl<TMarker: ?Sized, TValue> PartialEq<MutIdPtr<TMarker, TValue>> for MutIdPtr<TMarker, TValue> {
    fn eq(&self, other: &MutIdPtr<TMarker, TValue>) -> bool {
        self.to_mut_ptr().eq(&other.to_mut_ptr())
    }

    #[allow(clippy::partialeq_ne_impl)]
    fn ne(&self, other: &MutIdPtr<TMarker, TValue>) -> bool {
        self.to_mut_ptr().ne(&other.to_mut_ptr())
    }
}

#[allow(clippy::non_canonical_partial_ord_impl)]
impl<TMarker: ?Sized, TValue> PartialOrd for MutIdPtr<TMarker, TValue> {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        self.to_mut_ptr().partial_cmp(&other.to_mut_ptr())
    }

    fn lt(&self, other: &Self) -> bool {
        self.to_mut_ptr().lt(&other.to_mut_ptr())
    }

    fn le(&self, other: &Self) -> bool {
        self.to_mut_ptr().le(&other.to_mut_ptr())
    }

    fn gt(&self, other: &Self) -> bool {
        self.to_mut_ptr().gt(&other.to_mut_ptr())
    }

    fn ge(&self, other: &Self) -> bool {
        self.to_mut_ptr().ge(&other.to_mut_ptr())
    }
}

impl<TMarker: ?Sized, TValue> Pointer for MutIdPtr<TMarker, TValue> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        Pointer::fmt(&self.to_id_ptr(), f)
    }
}