Trait core::marker::Unpin

1.33.0 · source · []
pub auto trait Unpin { }
Expand description

Types that can be safely moved after being pinned.

Rust itself has no notion of immovable types, and considers moves (e.g., through assignment or mem::replace) to always be safe.

The Pin type is used instead to prevent moves through the type system. Pointers P<T> wrapped in the Pin<P<T>> wrapper can’t be moved out of. See the pin module documentation for more information on pinning.

Implementing the Unpin trait for T lifts the restrictions of pinning off the type, which then allows moving T out of Pin<P<T>> with functions such as mem::replace.

Unpin has no consequence at all for non-pinned data. In particular, mem::replace happily moves !Unpin data (it works for any &mut T, not just when T: Unpin). However, you cannot use mem::replace on data wrapped inside a Pin<P<T>> because you cannot get the &mut T you need for that, and that is what makes this system work.

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

use std::mem;
use std::pin::Pin;

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

// We need a mutable reference to call `mem::replace`.
// We can obtain such a reference by (implicitly) invoking `Pin::deref_mut`,
// but that is only possible because `String` implements `Unpin`.
mem::replace(&mut *pinned_string, "other".to_string());
Run

This trait is automatically implemented for almost every type.

Implementors

impl<T: ?Sized, A: Allocator> Unpin for Box<T, A> where
    A: 'static, 

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

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

Auto implementors

impl Unpin for Global

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

impl<'a, B: ?Sized> Unpin for Cow<'a, B> where
    <B as ToOwned>::Owned: Unpin

impl<T> Unpin for BinaryHeap<T> where
    T: Unpin

impl<'a, T> Unpin for PeekMut<'a, T>

impl<'a, T> Unpin for Iter<'a, T>

impl<T> Unpin for IntoIter<T> where
    T: Unpin

impl<T> Unpin for IntoIterSorted<T> where
    T: Unpin

impl<'a, T> Unpin for Drain<'a, T>

impl<'a, T> Unpin for DrainSorted<'a, T>

impl<'a, K, V, A> Unpin for Entry<'a, K, V, A> where
    K: Unpin

impl<'a, K, V, A> Unpin for VacantEntry<'a, K, V, A> where
    K: Unpin

impl<'a, K, V, A> Unpin for OccupiedEntry<'a, K, V, A>

impl<'a, K, V, A> Unpin for OccupiedError<'a, K, V, A> where
    V: Unpin

impl<K, V, A> Unpin for BTreeMap<K, V, A> where
    A: Unpin

impl<'a, K, V> Unpin for Iter<'a, K, V>

impl<'a, K, V> Unpin for IterMut<'a, K, V>

impl<K, V, A> Unpin for IntoIter<K, V, A> where
    A: Unpin

impl<'a, K, V> Unpin for Keys<'a, K, V>

impl<'a, K, V> Unpin for Values<'a, K, V>

impl<'a, K, V> Unpin for ValuesMut<'a, K, V>

impl<K, V, A> Unpin for IntoKeys<K, V, A> where
    A: Unpin

impl<K, V, A> Unpin for IntoValues<K, V, A> where
    A: Unpin

impl<'a, K, V> Unpin for Range<'a, K, V>

impl<'a, K, V> Unpin for RangeMut<'a, K, V>

impl<'a, K, V, F, A> Unpin for DrainFilter<'a, K, V, F, A> where
    A: Unpin,
    F: Unpin

impl<T, A> Unpin for BTreeSet<T, A> where
    A: Unpin

impl<'a, T> Unpin for Iter<'a, T>

impl<T, A> Unpin for IntoIter<T, A> where
    A: Unpin

impl<'a, T> Unpin for Range<'a, T>

impl<'a, T, A> Unpin for Difference<'a, T, A>

impl<'a, T> Unpin for SymmetricDifference<'a, T>

impl<'a, T, A> Unpin for Intersection<'a, T, A>

impl<'a, T> Unpin for Union<'a, T>

impl<'a, T, F, A> Unpin for DrainFilter<'a, T, F, A> where
    F: Unpin

impl<T> Unpin for LinkedList<T>

impl<'a, T> Unpin for Iter<'a, T>

impl<'a, T> Unpin for IterMut<'a, T>

impl<T> Unpin for IntoIter<T>

impl<'a, T> Unpin for Cursor<'a, T>

impl<'a, T> Unpin for CursorMut<'a, T>

impl<'a, T, F> Unpin for DrainFilter<'a, T, F> where
    F: Unpin

impl<'a, T, A> Unpin for Drain<'a, T, A>

impl<'a, T> Unpin for IterMut<'a, T>

impl<T, A> Unpin for IntoIter<T, A> where
    A: Unpin,
    T: Unpin

impl<'a, T> Unpin for Iter<'a, T>

impl<T, A> Unpin for VecDeque<T, A> where
    A: Unpin,
    T: Unpin

impl Unpin for CString

impl Unpin for NulError

impl<T: ?Sized> Unpin for Weak<T>

impl Unpin for String

impl<'a> Unpin for Drain<'a>

impl<T: ?Sized> Unpin for Weak<T>

impl<'a, T, F, A> Unpin for DrainFilter<'a, T, F, A> where
    F: Unpin

impl<'a, I, A> Unpin for Splice<'a, I, A> where
    I: Unpin

impl<'a, T, A> Unpin for Drain<'a, T, A>

impl<T, A> Unpin for IntoIter<T, A> where
    A: Unpin,
    T: Unpin

impl<T, A> Unpin for Vec<T, A> where
    A: Unpin,
    T: Unpin

impl<T> Unpin for LocalKey<T>

impl<'scope, 'env> Unpin for Scope<'scope, 'env>

impl<'scope, T> Unpin for ScopedJoinHandle<'scope, T>

impl Unpin for Builder

impl Unpin for ThreadId

impl Unpin for Thread

impl<T> Unpin for JoinHandle<T>

impl Unpin for Backtrace

impl<K, V, S> Unpin for HashMap<K, V, S> where
    K: Unpin,
    S: Unpin,
    V: Unpin

impl<'a, K, V> Unpin for Iter<'a, K, V>

impl<'a, K, V> Unpin for IterMut<'a, K, V>

impl<K, V> Unpin for IntoIter<K, V> where
    K: Unpin,
    V: Unpin

impl<'a, K, V> Unpin for Keys<'a, K, V>

impl<'a, K, V> Unpin for Values<'a, K, V>

impl<'a, K, V> Unpin for Drain<'a, K, V> where
    K: Unpin,
    V: Unpin

impl<'a, K, V, F> Unpin for DrainFilter<'a, K, V, F> where
    F: Unpin

impl<'a, K, V> Unpin for ValuesMut<'a, K, V>

impl<K, V> Unpin for IntoKeys<K, V> where
    K: Unpin,
    V: Unpin

impl<K, V> Unpin for IntoValues<K, V> where
    K: Unpin,
    V: Unpin

impl<'a, K, V, S> Unpin for RawEntryBuilderMut<'a, K, V, S>

impl<'a, K, V, S> Unpin for RawEntryMut<'a, K, V, S>

impl<'a, K, V, S> Unpin for RawOccupiedEntryMut<'a, K, V, S>

impl<'a, K, V, S> Unpin for RawVacantEntryMut<'a, K, V, S>

impl<'a, K, V, S> Unpin for RawEntryBuilder<'a, K, V, S>

impl<'a, K, V> Unpin for Entry<'a, K, V> where
    K: Unpin

impl<'a, K, V> Unpin for OccupiedEntry<'a, K, V> where
    K: Unpin

impl<'a, K, V> Unpin for VacantEntry<'a, K, V> where
    K: Unpin

impl<'a, K, V> Unpin for OccupiedError<'a, K, V> where
    K: Unpin,
    V: Unpin

impl<T, S> Unpin for HashSet<T, S> where
    S: Unpin,
    T: Unpin

impl<'a, K> Unpin for Iter<'a, K>

impl<K> Unpin for IntoIter<K> where
    K: Unpin

impl<'a, K> Unpin for Drain<'a, K> where
    K: Unpin

impl<'a, K, F> Unpin for DrainFilter<'a, K, F> where
    F: Unpin

impl<'a, T, S> Unpin for Intersection<'a, T, S>

impl<'a, T, S> Unpin for Difference<'a, T, S>

impl<'a, T, S> Unpin for SymmetricDifference<'a, T, S>

impl<'a, T, S> Unpin for Union<'a, T, S>

impl Unpin for Vars

impl Unpin for VarsOs

impl Unpin for VarError

impl<'a> Unpin for SplitPaths<'a>

impl Unpin for Args

impl Unpin for ArgsOs

impl<'a> Unpin for Chain<'a>

impl<E> Unpin for Report<E> where
    E: Unpin

impl Unpin for OsString

impl Unpin for OsStr

impl Unpin for File

impl Unpin for Metadata

impl Unpin for ReadDir

impl Unpin for DirEntry

impl Unpin for FileType

impl Unpin for DirBuilder

impl<R> Unpin for BufReader<R> where
    R: Unpin

impl<W> Unpin for BufWriter<W> where
    W: Unpin

impl<W> Unpin for LineWriter<W> where
    W: Unpin

impl<W> Unpin for IntoInnerError<W> where
    W: Unpin

impl<T> Unpin for Cursor<T> where
    T: Unpin

impl Unpin for Error

impl Unpin for ErrorKind

impl<'a> Unpin for ReadBuf<'a>

impl Unpin for Stdin

impl<'a> Unpin for StdinLock<'a>

impl Unpin for Stdout

impl<'a> Unpin for StdoutLock<'a>

impl Unpin for Stderr

impl<'a> Unpin for StderrLock<'a>

impl Unpin for Empty

impl Unpin for Repeat

impl Unpin for Sink

impl<'a> Unpin for IoSliceMut<'a>

impl<'a> Unpin for IoSlice<'a>

impl Unpin for SeekFrom

impl<T, U> Unpin for Chain<T, U> where
    T: Unpin,
    U: Unpin

impl<T> Unpin for Take<T> where
    T: Unpin

impl<R> Unpin for Bytes<R> where
    R: Unpin

impl<B> Unpin for Split<B> where
    B: Unpin

impl<B> Unpin for Lines<B> where
    B: Unpin

impl Unpin for SocketAddr

impl Unpin for IpAddr

impl Unpin for Ipv4Addr

impl Unpin for Ipv6Addr

impl Unpin for TcpStream

impl<'a> Unpin for Incoming<'a>

impl Unpin for UdpSocket

impl Unpin for Shutdown

impl<'fd> Unpin for BorrowedFd<'fd>

impl Unpin for OwnedFd

impl Unpin for SocketAddr

impl Unpin for SocketCred

impl<'a> Unpin for ScmRights<'a>

impl<'a> Unpin for ScmCredentials<'a>

impl<'a> Unpin for AncillaryData<'a>

impl<'a> Unpin for Messages<'a>

impl<'a> Unpin for SocketAncillary<'a>

impl<'a> Unpin for Incoming<'a>

impl Unpin for UnixStream

impl Unpin for UCred

impl Unpin for PidFd

impl Unpin for stat

impl<'a> Unpin for EncodeWide<'a>

impl<'handle> Unpin for BorrowedHandle<'handle>

impl<'socket> Unpin for BorrowedSocket<'socket>

impl<'a> Unpin for Prefix<'a>

impl<'a> Unpin for PrefixComponent<'a>

impl<'a> Unpin for Component<'a>

impl<'a> Unpin for Components<'a>

impl<'a> Unpin for Iter<'a>

impl<'a> Unpin for Ancestors<'a>

impl Unpin for PathBuf

impl Unpin for Path

impl<'a> Unpin for Display<'a>

impl<'a> Unpin for CommandEnvs<'a>

impl Unpin for Child

impl Unpin for ChildStdin

impl Unpin for Command

impl<'a> Unpin for CommandArgs<'a>

impl Unpin for Output

impl Unpin for Stdio

impl Unpin for ExitStatus

impl Unpin for ExitCode

impl<T> Unpin for Receiver<T>

impl<'a, T> Unpin for Iter<'a, T>

impl<'a, T> Unpin for TryIter<'a, T>

impl<T> Unpin for IntoIter<T>

impl<T> Unpin for Sender<T>

impl<T> Unpin for SyncSender<T>

impl<T> Unpin for SendError<T> where
    T: Unpin

impl Unpin for RecvError

impl<T> Unpin for TrySendError<T> where
    T: Unpin

impl Unpin for Barrier

impl Unpin for Condvar

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

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

impl Unpin for Once

impl Unpin for OnceState

impl<T> Unpin for PoisonError<T> where
    T: Unpin

impl<T> Unpin for TryLockError<T> where
    T: Unpin

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

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

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

impl Unpin for Instant

impl Unpin for SystemTime

impl<T> Unpin for SyncOnceCell<T> where
    T: Unpin

impl<T, F> Unpin for SyncLazy<T, F> where
    F: Unpin,
    T: Unpin

impl Unpin for System

impl Unpin for ()

impl<T> Unpin for (T₁, T₂, …, Tₙ) where
    T: Unpin

impl Unpin for f64

impl Unpin for f32