Struct StackPinned

pub struct StackPinned<'pin, T>(/* private fields */);

Struct that represents data that is pinned to the stack, at the point of declaration.

Because this property cannot be guaranteed by safe rust, constructing an instance of a StackPinned directly is unsafe. Rather, one should use the stack_let macro that returns a PinStack instance.

In particular, one should note the following about StackPinned instance:

• It is impossible to safely pass a StackPinned instance to a function
• It is impossible to safely return a StackPinned instance from a function
• It is impossible to safely store a StackPinned instance inside of a struct

Instead, one should replace StackPinned<T> with PinStack<T> in each of these situations.

A PinStack<T> instance does have its benefits:

• The underlying T instance is guaranteed to never move for T: !Unpin once pinned. This is useful for T types whose instances should never move.
• For T: !Unpin, the destructor of T is guaranteed to run when the T leaves the stack frame it was allocated on, even if one uses std::mem::forget on the PinStack<T> instance.

Implementations

impl<'pin, T> StackPinned<'pin, T>

pub unsafe fn new(t: &'pin mut T) -> Self

Safety

Currently the only way to build a safe StackPinned<T> instance is to use the stack_let macro that will return a PinStack<T> instance.

Trait Implementations

impl<'pin, T> Deref for StackPinned<'pin, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'pin, T> DerefMut for StackPinned<'pin, T>

fn deref_mut(&mut self) -> &mut <Self as Deref>::Target

Mutably dereferences the value.