basin2-lib 152.1.0

Basin2 subpackage for general use.
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

use std::fmt::{Debug, self};
use std::sync::atomic::{ AtomicPtr, Ordering };
use std::sync::Arc;
use std::ptr::null_mut;
use std::ops::Deref;

// n-settable, any-readonly-gettable option
pub struct AtomicRef<T: Send + Sync + ?Sized + 'static> {
    item: AtomicPtr<Arc<T>>,
}

impl<T: Send + Sync + ?Sized + 'static> Default for AtomicRef<T> {
    fn default() -> AtomicRef<T> {
        AtomicRef::new()
    }
}

impl<T: Debug + Send + Sync + ?Sized + 'static> Debug for AtomicRef<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        (*self.get()).fmt(f)
    }
}

impl<T: Clone + Send + Sync + ?Sized + 'static> Clone for AtomicRef<T> {
    fn clone(&self) -> Self {
        let ptr = self.item.load(Ordering::Relaxed);
        let ptr = if ptr == null_mut::<Arc<T>>() {
            ptr
        } else {
            Box::into_raw(Box::new(self.get())) as *mut Arc<T>
        };
        AtomicRef {
            item: AtomicPtr::new(ptr),
        }
    }
}

impl<T: PartialEq + Send + Sync + ?Sized + 'static> PartialEq for AtomicRef<T> {
    fn eq(&self, other: &Self) -> bool {
        return (*self.get()) == (*other.get());
    }
}

impl<T: Send + Sync + ?Sized + 'static> Drop for AtomicRef<T> {
    fn drop(&mut self) {
        let ptr = self.item.load(Ordering::Relaxed);
        if ptr != null_mut() {
            drop(unsafe { Box::from_raw(ptr) });
        }
    }
}

impl<T: Send + Sync + ?Sized + 'static> From<Arc<T>> for AtomicRef<T> {
    fn from(item: Arc<T>) -> AtomicRef<T> {
        return AtomicRef {
            item: AtomicPtr::new(Box::into_raw(Box::new(item)) as *mut Arc<T>),
        };
    }
}

impl<T: Send + Sync + ?Sized + 'static> Deref for AtomicRef<T> {
    type Target = T;

    fn deref(&self) -> &T {
        let ptr = self.item.load(Ordering::Relaxed);
        if ptr == null_mut::<Arc<T>>() {
            panic!("attempt to get value of unset AtomicRef!");
        }
        unsafe { ptr.as_ref().unwrap() }
    }
}

impl<T: Send + Sync + ?Sized + 'static> AtomicRef<T> {
    
    pub fn new() -> AtomicRef<T> {
        AtomicRef {
            item: AtomicPtr::new(null_mut::<Arc<T>>()),
        }
    }

    pub fn set(&self, item: Arc<T>) {
        let boxed_item = Box::into_raw(Box::new(item)) as *mut Arc<T>;
        let old_item = self.item.swap(boxed_item, Ordering::Relaxed);
        if old_item != null_mut() {
            drop(unsafe { Box::from_raw(old_item) });
        }
    }

    pub fn get(&self) -> Arc<T> {
        let ptr = self.item.load(Ordering::Relaxed);
        if ptr == null_mut::<Arc<T>>() {
            panic!("attempt to get value of unset AtomicRef!");
        }
        let original_arc = unsafe { Box::from_raw(ptr) };
        let returning_arc = (*original_arc).clone();
        Box::into_raw(original_arc);
        return returning_arc;
    }

    pub fn is_set(&self) -> bool {
        let ptr = self.item.load(Ordering::Relaxed);
        ptr != null_mut::<Arc<T>>()
    }
}

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

    #[derive(Debug, PartialEq, Eq)]
    struct TestStruct {
        value: u32,
    }

    #[test]
    fn test_ref_can_set() {
        let setter = AtomicRef::<TestStruct>::new();
        assert_eq!(setter.is_set(), false);
        setter.set(Arc::new(TestStruct { value: 243523 }));
        assert_eq!(setter.is_set(), true);

        assert_eq!(*setter.get(), TestStruct { value: 243523 });
        assert_eq!(setter.is_set(), true);
        let gotten = setter.get();
        drop(setter);
        assert_eq!(*gotten, TestStruct { value: 243523 });
        assert_eq!(Arc::strong_count(&gotten), 1);
    }

}