Struct moveit::move_ref::MoveRef

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

A library emulation of the theoretical &move T type.

A MoveRef<'a, T> represents a unique reference to T for the lifetime 'a. Unlike an &mut T, though, a MoveRef<T> is the longest-lived such reference, entitling it to run T’s destructor. In other words, MoveRef<T> owns its referent, but not its referent’s storage. See the module docs for more information.

The main mechanism for obtaining MoveRefs is the moveit!() macro, which is analogous to a theoretical &move expr operator. This actuates a DerefMove implementation.

Implementations

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

pub unsafe fn new_unchecked(ptr: &'a mut T) -> Self

Create a new MoveRef<T> out of a mutable reference.

Safety

ptr must satisfy the longest-lived criterion: after the return value goes out of scope, ptr must also be out-of-scope. Calling this function correctly is non-trivial, and should be left to moveit!() instead.

In particular, if ptr outlives the returned MoveRef, it will point to dropped memory, which is UB.

pub fn into_pin(this: Self) -> Pin<Self>

Convert a MoveRef<T> into a Pin<MoveRef<T>>.

Because we own the referent, we are entitled to pin it permanently. See Box::into_pin() for a standard-library equivalent.

impl<'a, T> MoveRef<'a, T>

pub fn into_inner(this: Self) -> T

Consume the MoveRef<T>, returning the wrapped value.

Trait Implementations

impl<T: ?Sized> Deref for MoveRef<'_, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T> DerefMove for MoveRef<'a, T>

type Uninit = MoveRef<'a, MaybeUninit<T>>

An “uninitialized” version of Self.

fn deinit(self) -> Self::Uninit

“Deinitializes” self, producing an opaque type that will destroy the storage of *self without calling the pointee destructor.

unsafe fn deref_move(this: &mut Self::Uninit) -> MoveRef<'_, Self::Target>

Moves out of this, producing a MoveRef that owns its contents.

impl<'a, T> DerefMove for MoveRef<'a, [T]>

type Uninit = MoveRef<'a, [MaybeUninit<T>]>

An “uninitialized” version of Self.

fn deinit(self) -> Self::Uninit

“Deinitializes” self, producing an opaque type that will destroy the storage of *self without calling the pointee destructor.

unsafe fn deref_move(this: &mut Self::Uninit) -> MoveRef<'_, Self::Target>

Moves out of this, producing a MoveRef that owns its contents.

impl<T: ?Sized> DerefMut for MoveRef<'_, T>

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

Mutably dereferences the value.

impl<T: ?Sized> Drop for MoveRef<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> From<MoveRef<'a, T>> for Pin<MoveRef<'a, T>>

fn from(x: MoveRef<'a, T>) -> Self

Performs the conversion.