Struct pinned_aliasable::Aliasable

pub struct Aliasable<T> { /* fields omitted */ }

An unboxed aliasable value.

Implementations

impl<T> Aliasable<T>

pub fn new(val: T) -> Self

Create a new Aliasable that stores val.

pub fn get(self: Pin<&Self>) -> &T

Get a shared reference to the value inside the Aliasable.

This method takes Pin<&Self> instead of &self to enforce that all parent containers are !Unpin, and thus won’t be annotated with noalias.

This crate intentionally does not provide a method to get an &mut T, because the value may be shared. To obtain an &mut T you should use an interior mutable container such as a mutex or UnsafeCell.

pub unsafe fn get_extended<'a>(self: Pin<&Self>) -> &'a T

Get a shared reference to the value inside the Aliasable with an extended lifetime.

Safety

The reference must not be held for longer than the Aliasable exists.

Trait Implementations

impl<T> Debug for Aliasable<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Default> Default for Aliasable<T>

fn default() -> Aliasable<T>

Returns the “default value” for a type.

impl<'__pin, T> Unpin for Aliasable<T> where
    __Origin<'__pin, T>: Unpin,