gemstone 0.4.5

collection of utilities
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

use core::ops::{Deref, DerefMut, Index, IndexMut};

/// Wrapper around a pointer that supports auto-deref, indexing, Send + Sync
pub struct Pointer<T>(*mut T);

impl<T> Pointer<T> {
    /// # Safety
    ///
    /// Up to the user to enusure that the data pointing to exists and is safe
    pub unsafe fn new(ptr: *const T) -> Self {
        Self(ptr as _)
    }

    /// # Safety
    ///
    /// Up to the user to set this to a valid location
    pub unsafe fn null() -> Self {
        Self(0 as _)
    }

    pub fn is_null(&self) -> bool {
        self.0.is_null()
    }
}

impl<T> Index<usize> for Pointer<T> {
    type Output = T;

    fn index(&self, index: usize) -> &Self::Output {
        unsafe { &*self.0.add(index) }
    }
}

impl<T> IndexMut<usize> for Pointer<T> {
    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
        unsafe { &mut *self.0.add(index) }
    }
}

impl<T> Deref for Pointer<T> {
    type Target = T;

    fn deref(&self) -> &T {
        unsafe { &(*self.0) }
    }
}

impl<T> DerefMut for Pointer<T> {
    fn deref_mut(&mut self) -> &mut T {
        unsafe { &mut (*self.0) }
    }
}

unsafe impl<T> Send for Pointer<T> {}
unsafe impl<T> Sync for Pointer<T> {}

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

    #[test]
    fn test_index() {
        let vals = [1, 2, 3, 4, 5];
        let ptr = unsafe { Pointer::new(&vals[0]) };

        assert_eq!(ptr[0], 1);
        assert_eq!(ptr[1], 2);
        assert_eq!(ptr[2], 3);
        assert_eq!(ptr[3], 4);
        assert_eq!(ptr[4], 5);
    }
}