enum-ptr 0.2.0

Ergonomic tagged pointer
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

use crate::{Compact, Compactable, FieldDeref, FieldDerefMut};

#[doc(hidden)]
#[inline]
pub unsafe fn get_ref_helper<T, U>(
    compact: &Compact<T>,
    f: impl FnOnce(&T) -> Option<&U>,
) -> Option<<U as FieldDeref>::Target<'_>>
where
    T: Compactable,
    U: FieldDeref,
{
    compact.map_ref(|tmp| f(tmp).map(|tmp| tmp.force_deref()))
}

#[doc(hidden)]
#[inline]
pub unsafe fn get_mut_helper<T, U>(
    compact: &mut Compact<T>,
    f: impl FnOnce(&mut T) -> Option<&mut U>,
) -> Option<<U as FieldDerefMut>::Target<'_>>
where
    T: Compactable,
    U: FieldDerefMut,
{
    compact.map_mut(|tmp| f(tmp).map(|tmp| tmp.force_deref_mut()))
}

/// Borrows a variant from [`Compact`].
///
/// It requires the type of that variant implements [`FieldDeref`].
///
/// # Examples
///
/// ```
/// # #[cfg(feature = "alloc")] {
/// use enum_ptr::{get_ref, Compact, EnumPtr};
///
/// #[derive(EnumPtr)]
/// #[repr(C, usize)]
/// enum Foo {
///     A(Box<i32>),
///     B(Box<u32>),
/// }
///
/// let foo: Compact<_> = Foo::A(Box::new(1)).into();
/// assert_eq!(get_ref!(foo, Foo::A), Some(&1));
/// assert_eq!(get_ref!(foo, Foo::B), None);
/// # }
/// ```
#[macro_export]
macro_rules! get_ref {
    ($compact:expr, $variant:path) => {
        unsafe {
            $crate::get_ref_helper(&$compact, |tmp| match tmp {
                $variant(inner) => Some(inner),
                _ => None,
            })
        }
    };
}

/// Mutably borrows a variant from [`Compact`].
///
/// It requires the type of that variant implements [`FieldDerefMut`].
///
/// # Examples
///
/// ```
/// # #[cfg(feature = "alloc")] {
/// use enum_ptr::{get_mut, Compact, EnumPtr};
///
/// #[derive(EnumPtr)]
/// #[repr(C, usize)]
/// enum Foo {
///     A(Box<i32>),
///     B(Box<u32>),
/// }
///
/// let mut foo: Compact<_> = Foo::A(Box::new(1)).into();
/// assert_eq!(get_mut!(foo, Foo::A), Some(&mut 1));
/// assert_eq!(get_mut!(foo, Foo::B), None);
/// # }
/// ```
#[macro_export]
macro_rules! get_mut {
    ($compact:expr, $variant:path) => {
        unsafe {
            $crate::get_mut_helper(&mut $compact, |tmp| match tmp {
                $variant(inner) => Some(inner),
                _ => None,
            })
        }
    };
}