vendor/pin-utils-0.1.0/src/projection.rs

/// A pinned projection of a struct field.
///
/// # Safety
///
/// To make using this macro safe, three things need to be ensured:
/// - If the struct implements [`Drop`], the [`drop`] method is not allowed to
///   move the value of the field.
/// - If the struct wants to implement [`Unpin`], it has to do so conditionally:
///   The struct can only implement [`Unpin`] if the field's type is [`Unpin`].
/// - The struct must not be `#[repr(packed)]`.
///
/// # Example
///
/// ```rust
/// use pin_utils::unsafe_pinned;
/// use std::marker::Unpin;
/// use std::pin::Pin;
///
/// struct Foo<T> {
///     field: T,
/// }
///
/// impl<T> Foo<T> {
///     unsafe_pinned!(field: T);
///
///     fn baz(mut self: Pin<&mut Self>) {
///         let _: Pin<&mut T> = self.field(); // Pinned reference to the field
///     }
/// }
///
/// impl<T: Unpin> Unpin for Foo<T> {} // Conditional Unpin impl
/// ```
///
/// Note: borrowing the field multiple times requires using `.as_mut()` to
/// avoid consuming the `Pin`.
///
/// [`Unpin`]: core::marker::Unpin
/// [`drop`]: Drop::drop
#[macro_export]
macro_rules! unsafe_pinned {
    ($f:tt: $t:ty) => (
        #[allow(unsafe_code)]
        fn $f<'__a>(
            self: $crate::core_reexport::pin::Pin<&'__a mut Self>
        ) -> $crate::core_reexport::pin::Pin<&'__a mut $t> {
            unsafe {
                $crate::core_reexport::pin::Pin::map_unchecked_mut(
                    self, |x| &mut x.$f
                )
            }
        }
    )
}

/// An unpinned projection of a struct field.
///
/// # Safety
///
/// This macro is unsafe because it creates a method that returns a normal
/// non-pin reference to the struct field. It is up to the programmer to ensure
/// that the contained value can be considered not pinned in the current
/// context.
///
/// # Example
///
/// ```rust
/// use pin_utils::unsafe_unpinned;
/// use std::pin::Pin;
///
/// struct Bar;
/// struct Foo {
///     field: Bar,
/// }
///
/// impl Foo {
///     unsafe_unpinned!(field: Bar);
///
///     fn baz(mut self: Pin<&mut Self>) {
///         let _: &mut Bar = self.field(); // Normal reference to the field
///     }
/// }
/// ```
///
/// Note: borrowing the field multiple times requires using `.as_mut()` to
/// avoid consuming the [`Pin`].
///
/// [`Pin`]: core::pin::Pin
#[macro_export]
macro_rules! unsafe_unpinned {
    ($f:tt: $t:ty) => (
        #[allow(unsafe_code)]
        fn $f<'__a>(
            self: $crate::core_reexport::pin::Pin<&'__a mut Self>
        ) -> &'__a mut $t {
            unsafe {
                &mut $crate::core_reexport::pin::Pin::get_unchecked_mut(self).$f
            }
        }
    )
}