Trait std::pin::Unpin

pub auto trait Unpin { }
🔬 This is a nightly-only experimental API. (pin #49150)

Types which can be safely moved after being pinned.

Since Rust itself has no notion of immovable types, and will consider moves to always be safe, this trait cannot prevent types from moving by itself.

Instead it can be used to prevent moves through the type system, by controlling the behavior of special pointer types like PinMut, which "pin" the type in place by not allowing it to be moved out of them. See the pin module documentation for more information on pinning.

Implementing this trait lifts the restrictions of pinning off a type, which then allows it to move out with functions such as replace.

So this, for example, can only be done on types implementing Unpin:

use std::mem::replace;
use std::pin::PinMut;

let mut string = "this".to_string();
let mut pinned_string = PinMut::new(&mut string);

// dereferencing the pointer mutably is only possible because String implements Unpin
replace(&mut *pinned_string, "other".to_string());

This trait is automatically implemented for almost every type.


impl !Unpin for Pinned [src]

impl Unpin for LocalWaker [src]

impl Unpin for Waker [src]

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

impl<'a, T> Unpin for &'a mut T where
    T: 'a + ?Sized

impl<'a, T> Unpin for FutureObj<'a, T> [src]

impl<'a, T> Unpin for LocalFutureObj<'a, T> [src]

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

impl<T> Unpin for Box<T> where
    T: ?Sized

impl<T> Unpin for PinBox<T> where
    T: ?Sized

impl<T> Unpin for Rc<T> where
    T: ?Sized

impl<T> Unpin for Arc<T> where
    T: ?Sized

Auto implementors

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.