Struct pin_api::Pin

pub struct Pin<'a, T: ?Sized + 'a> { /* fields omitted */ }

A pinned reference.

The value referenced by this is guaranteed never to move again, unless it implements Unpin.

Methods

impl<'a, T: Unpin + ?Sized> Pin<'a, T>

pub fn new(ptr: &'a T) -> Pin<'a, T>

Create a new Pin from a reference to a moveable type.

impl<'a, T: ?Sized> Pin<'a, T>

pub unsafe fn new_unchecked(ptr: &'a T) -> Pin<'a, T>

Construct a new Pin without checking that the data is actually pinned.

You must guarantee that the data meets the requirements for constructing a Pin.

An example use case is constructing a Pin of a field of this type:

let inner = unsafe { Pin::new_unchecked(&this.inner) };

pub fn borrow<'b>(this: &'b Pin<'a, T>) -> Pin<'b, T>

Get a Pin with a shorter lifetime

pub unsafe fn get<'b>(this: &'b mut Pin<'a, T>) -> &'b T

Get a reference to the data inside this type.

This is unsafe, because you must guarantee that you do not move the data out of the reference that this function returns.

Trait Implementations

impl<'a, T: ?Sized> Deref for Pin<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: ?Sized, U> CoerceUnsized<Pin<'a, U>> for Pin<'a, T> where
    T: Unsize<U>,
    U: ?Sized,