Struct std::mem::PinMut

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

🔬 This is a nightly-only experimental API. (pin #49150)

A pinned reference.

A pinned reference is a lot like a mutable reference, except that it is not safe to move a value out of a pinned reference unless the type of that value implements the Unpin trait.

Methods

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

pub fn new(reference: &'a mut T) -> PinMut<'a, T>

🔬 This is a nightly-only experimental API. (pin #49150)

Construct a new PinMut around a reference to some data of a type that implements Unpin.

impl<'a, T> PinMut<'a, T> where     T: ?Sized,

pub unsafe fn new_unchecked(reference: &'a mut T) -> PinMut<'a, T>

🔬 This is a nightly-only experimental API. (pin #49150)

Construct a new PinMut around a reference to some data of a type that may or may not implement Unpin.

This constructor is unsafe because we do not know what will happen with that data after the reference ends. If you cannot guarantee that the data will never move again, calling this constructor is invalid.

pub fn reborrow(&'b mut self) -> PinMut<'b, T>

🔬 This is a nightly-only experimental API. (pin #49150)

Reborrow a PinMut for a shorter lifetime.

For example, PinMut::get_mut(x.reborrow()) (unsafely) returns a short-lived mutable reference reborrowing from x.

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W

pub unsafe fn get_mut(this: PinMut<'a, T>) -> &'a mut T

🔬 This is a nightly-only experimental API. (pin #49150)

Get a mutable reference to the data inside of this PinMut.

This function is unsafe. You must guarantee that you will never move the data out of the mutable reference you receive when you call this function.

pub unsafe fn map<U, F>(this: PinMut<'a, T>, f: F) -> PinMut<'a, U> where     F: FnOnce(&mut T) -> &mut U,

🔬 This is a nightly-only experimental API. (pin #49150)

Construct a new pin by mapping the interior value.

For example, if you wanted to get a PinMut of a field of something, you could use this to get access to that field in one line of code.

This function is unsafe. You must guarantee that the data you return will not move so long as the argument value does not move (for example, because it is one of the fields of that value), and also that you do not move out of the argument you receive to the interior function.

Trait Implementations

impl<'a, T> Display for PinMut<'a, T> where     T: Display + ?Sized,

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

Formats the value using the given formatter.

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

impl<'a, T> Pointer for PinMut<'a, T> where     T: ?Sized,

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

Formats the value using the given formatter.

impl<'a, T> Debug for PinMut<'a, T> where     T: Debug + ?Sized,

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

Formats the value using the given formatter.

impl<'a, T> Unpin for PinMut<'a, T> where     T: ?Sized,

impl<'a, T> DerefMut for PinMut<'a, T> where     T: Unpin + ?Sized,

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

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

type Target = T

The resulting type after dereferencing.

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W

fn deref(&self) -> &T

Dereferences the value.