Struct stackpin::Unpinned

pub struct Unpinned<U, T: FromUnpinned<U>> { /* fields omitted */ }

A helper struct around U that remembers the T destination type.

This struct is typically used to build PinStack values using the stack_let macro without having to specify the destination type.

Example

use stackpin::stack_let;
// Without `Unpinned`
fn new_string(s : impl Into<String>) -> String { s.into() }
stack_let!(unmovable : Unmovable = new_string("toto"));
// With `Unpinned`
fn new_unpinned(s : impl Into<String>) -> Unpinned<String, Unmovable> { Unpinned::new(s.into()) }
stack_let!(unmovable = new_unpinned("toto"));

Methods

impl<U, T: FromUnpinned<U>> Unpinned<U, T>

pub fn new(u: U) -> Self

Trait Implementations

impl<U, T: FromUnpinned<U>> FromUnpinned<Unpinned<U, T>> for T

type PinData = <T as FromUnpinned<U>>::PinData

This associated type can be used to retain information between the creation of the instance and its pinning. This allows for some sort of "two-steps initialization" without having to store the initialization part in the type itself.

unsafe fn from_unpinned(src: Unpinned<U, T>) -> (Self, Self::PinData)

Performs a first initialization step, resulting in the creation of the Self instance.

unsafe fn on_pin(&mut self, pin_data: Self::PinData)

Performs a second initialization step, resulting in the pinning of the Self instance.