ointer 3.0.12

Steal the high bits of a pointer to store an extra value
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

//! This crate provides a set of traits and macros to enable the creation of custom pointers in Rust, allowing for the storage of extra information in the high bits of a pointer. This extra information can be of various types, and the crate provides utilities for working with these custom pointers efficiently. The crate also offers convenient macros for defining custom `ointer`s and `enum ointers` and managing them.

mod ointer;
pub use ointer::*;
pub mod boxed;
pub use boxed::*;
pub mod rc;
pub mod sync;

/// Type alias for `boxed::OBox`
pub type Ox<T> = OBox<T>;
/// Type alias for `rc::ORc`
pub type Oc<T> = rc::ORc<T>;
/// Type alias for `rc::OWeak`
pub type Ok<T> = rc::OWeak<T>;
/// Type alias for `sync::OArc`
pub type Orc<T> = sync::OArc<T>;
/// Type alias for `sync::OWeak`
pub type Oak<T> = sync::OWeak<T>;

/// Test the Ointer Library
#[cfg(test)]
mod tests {
    // Import the necessary modules and types.
    use super::{rc::*, sync::*, *};
    use std::{mem::size_of, pin::Pin, rc::Rc, sync::*};

    // Define a test function.
    #[test]
    fn test() {
        {
            // Test custom ointers (OBox).
            let mut o = OBox::new(1);
            assert_eq!(*o, 1);
            assert_eq!(o.get::<bool>(), false);
            assert_eq!(*o, 1);
            *o = i32::default();
            assert_eq!(*o, i32::default());
            o.set_bool(true);
            let b = o.get_bool();
            assert_eq!(b, true);
            o.set_mut(false);
            assert_eq!(o, Pin::into_inner(OBox::pin(Default::default())));
        }
        {
            // Test custom strong ointers (BArc).
            let mut o = BArc::new(1);
            assert_eq!(*o, 1);
            assert_eq!(o.get::<bool>(), false);

            // Define a small enum for testing.
            #[derive(Clone, Copy, PartialEq, Debug)]
            enum MySmallEnum {
                _A,
                B,
                _C,
            }
            assert_eq!(size_of::<MySmallEnum>(), 1);

            o.set_mut(MySmallEnum::B);
            assert_eq!(*o, 1);
            assert_eq!(o.get::<MySmallEnum>(), MySmallEnum::B);

            // Modify the bool and pointer inside the ointer.
            o.map_mut(|b: &mut bool, p| {
                *b = !*b;
                *p = Default::default();
            });
            assert_eq!(*o.downgrade().upgrade().unwrap(), Default::default());
        }
        {
            let mut a = Arc::new(13);

            // Define custom enum ointers using MyEnumOinters.
            define_enum_ointers!(
                MyEnumOinters {
                    Box<f64> = 1,
                    Arc<i32> = 2,
                    i32 = 5
                },
                8
            );

            let mut e = MyEnumOinters::new(2, a.clone());
            assert_eq!(Arc::strong_count(&a), 2);

            // Perform operations on the enum ointer.
            assert_eq!(
                e.map_enum_mut(
                    |_| panic!(),
                    |p| {
                        let i = **p;
                        *p = Arc::new(15);
                        assert_eq!(Arc::strong_count(&a), 1);
                        a = p.clone();
                        i
                    },
                    |_| panic!()
                ),
                13
            );
            assert_eq!(e.map_enum(|_| panic!(), |p1| **p1, |_| panic!()), 15);
            assert_eq!(Arc::strong_count(&a), 2);

            // Set the enum ointer to a new value (Box<f64>).
            e.set_mut(1, Box::new(2.0));
            assert_eq!(Arc::strong_count(&a), 1);
            assert_eq!(e.map_enum(|p| **p, |_| panic!(), |_| panic!()), 2.0);
            assert_eq!(size_of::<Option<MyEnumOinters>>(), size_of::<usize>());
        }

        // Test size comparison of Rc<i32> and Option<BRc<i32>>.
        assert_eq!(size_of::<Rc<i32>>(), size_of::<Option<BRc<i32>>>());
    }
}