munge 0.4.7

Macro for custom destructuring
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

use core::{hint::unreachable_unchecked, marker::PhantomData};

use crate::{internal, Borrow, Destructure, Restructure};

pub fn make_destructurer<T: Destructure>(
    value: T,
) -> <T::Destructuring as internal::DestructuringFor<T>>::Destructurer
where
    T::Destructuring: internal::DestructuringFor<T>,
{
    internal::Destructurer::new(value)
}

pub fn destructurer_ptr<T: internal::Destructurer>(
    destructurer: &mut T,
) -> *mut <T::Inner as Destructure>::Underlying {
    Destructure::underlying(destructurer.inner_mut())
}

/// # Safety
///
/// `test_destructurer` may not be called.
pub unsafe fn test_destructurer<'a, T: internal::Test<'a>>(
    _: &'a mut T,
) -> T::Test {
    // SAFETY: `test_destructurer` may not be called.
    unsafe { unreachable_unchecked() }
}

/// # Safety
///
/// `ptr` must be a properly-aligned pointer to a subfield of the pointer
/// underlying the inner value of `destructurer`.
pub unsafe fn restructure_destructurer<T: internal::Destructurer, U>(
    destructurer: &T,
    ptr: *mut U,
) -> <T::Inner as Restructure<U>>::Restructured
where
    T::Inner: Restructure<U>,
{
    // SAFETY: The caller has guaranteed that `ptr` is a properly-aligned
    // pointer to a subfield of the pointer underlying the inner value of
    // `destructurer`.
    unsafe {
        Restructure::restructure(
            internal::Destructurer::inner(destructurer),
            ptr,
        )
    }
}

#[diagnostic::on_unimplemented(
    message = "munge may not destructure a rest pattern by move",
    label = "this rest pattern requires destructuring by borrow"
)]
pub trait MustBeBorrow {}

#[diagnostic::do_not_recommend]
impl MustBeBorrow for Borrow {}

pub fn get_destructuring_ptr<T>(
    _: &T,
) -> *const <T::Inner as Destructure>::Destructuring
where
    T: internal::Destructurer,
    T::Inner: Destructure,
{
    core::ptr::null()
}

pub struct Value;

pub struct Reference;

#[diagnostic::on_unimplemented(
    message = "munge may not destructure through references",
    label = "destructuring with this pattern causes an implicit dereference",
    note = "only values may be destructured"
)]
pub trait MustBeAValue {
    fn check(&self) {}
}

#[diagnostic::do_not_recommend]
impl MustBeAValue for Value {}

pub trait MaybeReference {
    fn test(&self) -> Value {
        Value
    }
}

impl<T: ?Sized> MaybeReference for T {}

pub struct IsReference<T: ?Sized>(PhantomData<T>);

impl<T: ?Sized> IsReference<T> {
    pub fn for_ptr(_: *mut T) -> Self {
        Self(PhantomData)
    }
}

impl<T: ?Sized> IsReference<&mut T> {
    pub fn test(&self) -> Reference {
        Reference
    }
}

impl<T: ?Sized> IsReference<&T> {
    pub fn test(&self) -> Reference {
        Reference
    }
}