easy-pin 0.0.1-alpha

Using Pin made easy.
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

/// The main `proc_macro_attribute`
pub use ::easy_pin_proc_macro::easy_pin;

/// Stuff exported under a name collision with the proc_macro_attribute
#[doc(hidden)] pub mod easy_pin {pub use super::{
    core,
    PinDrop,
    PinSensitive,
};}

pub
trait PinDrop : Drop {
    /// # Safety
    ///
    ///   - `PinDrop::drop_pinned` must never be called directly,
    ///     only by `Drop::drop` (_e.g._, generated by `#[easy_pin(Drop)]`)
    ///
    ///   - However, **it must always be safe to call on `Drop`**, even when
    ///     `Self` has never been behind a `Pin`-ned pointer.
    unsafe
    fn drop_pinned (self: core::pin::Pin<&'_ mut Self>);
}

#[derive(
    Debug,
    // Clone, /* `!Unpin` stuff should not have #[derive(Clone)] accessible */
    PartialEq, Eq,
    PartialOrd, Ord,
)]
#[repr(transparent)]
pub
struct PinSensitive<T> {
    inner: T,
    _marker: core::marker::PhantomPinned,
}

impl<T : Default> Default for PinSensitive<T> {
    #[inline]
    fn default () -> Self
    {
        Self {
            inner: Default::default(),
            _marker: core::marker::PhantomPinned,
        }
    }
}

impl<T> PinSensitive<T> {
    #[inline]
    pub
    fn new (value: T) -> Self
    {
        Self {
            inner: value,
            _marker: core::marker::PhantomPinned,
        }
    }

    #[inline]
    pub
    fn pinned_address<'__> (
        self: core::pin::Pin<&'__ Self>,
    ) -> core::ptr::NonNull<T> // variance is justified because *const
    {
        (&self.inner).into()
    }
}

impl<T> core::ops::Deref for PinSensitive<T> {
    type Target = T;

    #[inline]
    fn deref (self: &'_ Self) -> &'_ Self::Target
    {
        &self.inner
    }
}
impl<T> core::ops::DerefMut for PinSensitive<T> {
    #[inline]
    fn deref_mut (self: &'_ mut Self) -> &'_ mut Self::Target
    {
        &mut self.inner
    }
}

#[doc(hidden)]
pub use ::core;