pub unsafe auto trait Sync { }Expand description
Types for which it is safe to share references between threads.
This trait is automatically implemented when the compiler determines it’s appropriate.
The precise definition is: a type T is Sync if and only if &T is
Send. In other words, if there is no possibility of
undefined behavior (including data races) when passing
&T references between threads.
As one would expect, primitive types like u8 and f64
are all Sync, and so are simple aggregate types containing them,
like tuples, structs and enums. More examples of basic Sync
types include “immutable” types like &T, and those with simple
inherited mutability, such as Box<T>, Vec<T> and
most other collection types. (Generic parameters need to be Sync
for their container to be Sync.)
A somewhat surprising consequence of the definition is that &mut T
is Sync (if T is Sync) even though it seems like that might
provide unsynchronized mutation. The trick is that a mutable
reference behind a shared reference (that is, & &mut T)
becomes read-only, as if it were a & &T. Hence there is no risk
of a data race.
A shorter overview of how Sync and Send relate to referencing:
&TisSendif and only ifTisSync&mut TisSendif and only ifTisSend&Tand&mut TareSyncif and only ifTisSync
Types that are not Sync are those that have “interior
mutability” in a non-thread-safe form, such as Cell
and RefCell. These types allow for mutation of
their contents even through an immutable, shared reference. For
example the set method on Cell<T> takes &self, so it requires
only a shared reference &Cell<T>. The method performs no
synchronization, thus Cell cannot be Sync.
Another example of a non-Sync type is the reference-counting
pointer Rc. Given any reference &Rc<T>, you can clone
a new Rc<T>, modifying the reference counts in a non-atomic way.
For cases when one does need thread-safe interior mutability,
Rust provides atomic data types, as well as explicit locking via
sync::Mutex and sync::RwLock. These types
ensure that any mutation cannot cause data races, hence the types
are Sync. Likewise, sync::Arc provides a thread-safe
analogue of Rc.
Any types with interior mutability must also use the
cell::UnsafeCell wrapper around the value(s) which
can be mutated through a shared reference. Failing to doing this is
undefined behavior. For example, transmute-ing
from &T to &mut T is invalid.
See the Nomicon for more details about Sync.
Dyn Compatibility§
This trait is dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety".
Implementors§
impl !Sync for Args
impl !Sync for ArgsOs
impl !Sync for Arguments<'_>
impl !Sync for LocalWaker
impl !Sync for VarsOs
impl Sync for Atom
Immutable, so it’s safe to be shared between threads
impl Sync for bytes::bytes::Bytes
impl Sync for core::ffi::c_str::Bytes<'_>
impl Sync for BytesMut
impl Sync for DIR
impl Sync for alloc::string::Drain<'_>
impl Sync for GuardNoSend
impl Sync for Location<'_>
impl Sync for TypeId
impl Sync for Waker
impl Sync for Wtf8Atom
Immutable, so it’s safe to be shared between threads
impl<'a, 'b, K, Q, V, S, A> Sync for OccupiedEntryRef<'a, 'b, K, Q, V, S, A>
impl<'a, R, G, T> Sync for MappedReentrantMutexGuard<'a, R, G, T>
impl<'a, R, G, T> Sync for ReentrantMutexGuard<'a, R, G, T>
impl<'a, R, T> Sync for lock_api::mutex::MappedMutexGuard<'a, R, T>
impl<'a, R, T> Sync for lock_api::rwlock::MappedRwLockReadGuard<'a, R, T>
impl<'a, R, T> Sync for lock_api::rwlock::MappedRwLockWriteGuard<'a, R, T>
impl<'a, R, T> Sync for lock_api::mutex::MutexGuard<'a, R, T>
impl<'a, R, T> Sync for RwLockUpgradableReadGuard<'a, R, T>
impl<'a, T> Sync for ArcBorrow<'a, T>
impl<'a, T> Sync for smallvec::Drain<'a, T>
impl<'a, T> Sync for OnceRef<'a, T>where
T: Sync,
impl<'a, T> Sync for ZeroVec<'a, T>
impl<'a> Sync for IoSlice<'a>
impl<'a> Sync for IoSliceMut<'a>
impl<A, B> Sync for ArcUnion<A, B>
impl<C> Sync for CartableOptionPointer<C>where
C: Sync + CartablePointerLike,
impl<Dyn> Sync for DynMetadata<Dyn>where
Dyn: ?Sized,
impl<H, T> Sync for ThinArc<H, T>
impl<K, V, S, A> Sync for OccupiedEntry<'_, K, V, S, A>
impl<K, V, S, A> Sync for RawOccupiedEntryMut<'_, K, V, S, A>
impl<M, T, O> Sync for BitRef<'_, M, T, O>
impl<R, G, T> Sync for ReentrantMutex<R, G, T>
impl<R, G> Sync for RawReentrantMutex<R, G>
impl<R, T> Sync for lock_api::mutex::Mutex<R, T>
impl<R, T> Sync for lock_api::rwlock::RwLock<R, T>
impl<R, T> Sync for lock_api::rwlock::RwLockReadGuard<'_, R, T>
impl<R, T> Sync for lock_api::rwlock::RwLockWriteGuard<'_, R, T>
impl<T, A> !Sync for Rc<T, A>
impl<T, A> !Sync for UniqueRc<T, A>
impl<T, A> !Sync for alloc::rc::Weak<T, A>
impl<T, A> Sync for swc_common::sync::Lrc<T, A>
impl<T, A> Sync for Box<T, A>
impl<T, A> Sync for Cursor<'_, T, A>
impl<T, A> Sync for CursorMut<'_, T, A>
impl<T, A> Sync for alloc::collections::vec_deque::drain::Drain<'_, T, A>
impl<T, A> Sync for alloc::vec::drain::Drain<'_, T, A>
impl<T, A> Sync for Drain<'_, T, A>
impl<T, A> Sync for alloc::vec::into_iter::IntoIter<T, A>
impl<T, A> Sync for IntoIter<T, A>
impl<T, A> Sync for LinkedList<T, A>
impl<T, A> Sync for OccupiedEntry<'_, T, A>
impl<T, A> Sync for RawDrain<'_, T, A>
impl<T, A> Sync for RawIntoIter<T, A>
impl<T, A> Sync for RawTable<T, A>
impl<T, A> Sync for alloc::sync::UniqueArc<T, A>
impl<T, A> Sync for alloc::sync::Weak<T, A>
impl<T, F, S> Sync for ScopeGuard<T, F, S>
impl<T, F> Sync for Lazy<T, F>
impl<T, F> Sync for LazyLock<T, F>
impl<T, O> Sync for BitBox<T, O>
impl<T, O> Sync for BitSlice<T, O>
§Bit-Slice Thread Safety
This allows bit-slice references to be moved across thread boundaries only when
the underlying T element can tolerate concurrency.
All BitSlice references, shared or exclusive, are only threadsafe if the T
element type is Send, because any given bit-slice reference may only have
partial control of a memory element that is also being shared by a bit-slice
reference on another thread. As such, this is never implemented for Cell<U>,
but always implemented for AtomicU and U for a given unsigned integer type
U.
Atomic integers safely handle concurrent writes, cells do not allow concurrency
at all, so the only missing piece is &mut BitSlice<_, U: Unsigned>. This is
handled by the aliasing system that the mutable splitters employ: a mutable
reference to an unsynchronized bit-slice can only cross threads when no other
handle is able to exist to the elements it governs. Splitting a mutable
bit-slice causes the split halves to change over to either atomics or cells, so
concurrency is either safe or impossible.
impl<T, O> Sync for BitVec<T, O>
impl<T, O> Sync for bitvec::vec::iter::Drain<'_, T, O>
impl<T, O> Sync for bitvec::boxed::iter::IntoIter<T, O>
impl<T, O> Sync for bitvec::slice::iter::Iter<'_, T, O>
impl<T, O> Sync for bitvec::slice::iter::IterMut<'_, T, O>
impl<T> !Sync for *const Twhere
T: ?Sized,
impl<T> !Sync for *mut Twhere
T: ?Sized,
impl<T> !Sync for Cell<T>where
T: ?Sized,
impl<T> !Sync for NonNull<T>where
T: ?Sized,
NonNull pointers are not Sync because the data they reference may be aliased.
impl<T> !Sync for core::cell::once::OnceCell<T>
impl<T> !Sync for std::sync::mpsc::Receiver<T>
impl<T> !Sync for RefCell<T>where
T: ?Sized,
impl<T> !Sync for UnsafeCell<T>where
T: ?Sized,
impl<T> Sync for triomphe::arc::Arc<T>
impl<T> Sync for Atomic<T>where
T: AtomicPrimitive,
impl<T> Sync for BitSpanError<T>where
T: BitStore,
impl<T> Sync for ChunksExactMut<'_, T>where
T: Sync,
impl<T> Sync for ChunksMut<'_, T>where
T: Sync,
impl<T> Sync for core::slice::iter::Iter<'_, T>where
T: Sync,
impl<T> Sync for alloc::collections::linked_list::Iter<'_, T>where
T: Sync,
impl<T> Sync for core::slice::iter::IterMut<'_, T>where
T: Sync,
impl<T> Sync for alloc::collections::linked_list::IterMut<'_, T>where
T: Sync,
impl<T> Sync for JoinHandle<T>
impl<T> Sync for std::sync::nonpoison::mutex::MappedMutexGuard<'_, T>
impl<T> Sync for std::sync::poison::mutex::MappedMutexGuard<'_, T>
impl<T> Sync for std::sync::nonpoison::rwlock::MappedRwLockReadGuard<'_, T>
impl<T> Sync for std::sync::poison::rwlock::MappedRwLockReadGuard<'_, T>
impl<T> Sync for std::sync::nonpoison::rwlock::MappedRwLockWriteGuard<'_, T>
impl<T> Sync for std::sync::poison::rwlock::MappedRwLockWriteGuard<'_, T>
impl<T> Sync for MisalignError<T>
impl<T> Sync for std::sync::nonpoison::mutex::Mutex<T>
T must be Send for Mutex to be Sync.
This ensures that the protected data can be accessed safely from multiple threads
without causing data races or other unsafe behavior.
Mutex<T> provides mutable access to T to one thread at a time. However, it’s essential
for T to be Send because it’s not safe for non-Send structures to be accessed in
this manner. For instance, consider Rc, a non-atomic reference counted smart pointer,
which is not Send. With Rc, we can have multiple copies pointing to the same heap
allocation with a non-atomic reference count. If we were to use Mutex<Rc<_>>, it would
only protect one instance of Rc from shared access, leaving other copies vulnerable
to potential data races.
Also note that it is not necessary for T to be Sync as &T is only made available
to one thread at a time if T is not Sync.
impl<T> Sync for std::sync::poison::mutex::Mutex<T>
T must be Send for Mutex to be Sync.
This ensures that the protected data can be accessed safely from multiple threads
without causing data races or other unsafe behavior.
Mutex<T> provides mutable access to T to one thread at a time. However, it’s essential
for T to be Send because it’s not safe for non-Send structures to be accessed in
this manner. For instance, consider Rc, a non-atomic reference counted smart pointer,
which is not Send. With Rc, we can have multiple copies pointing to the same heap
allocation with a non-atomic reference count. If we were to use Mutex<Rc<_>>, it would
only protect one instance of Rc from shared access, leaving other copies vulnerable
to potential data races.
Also note that it is not necessary for T to be Sync as &T is only made available
to one thread at a time if T is not Sync.
impl<T> Sync for std::sync::nonpoison::mutex::MutexGuard<'_, T>
T must be Sync for a MutexGuard<T> to be Sync
because it is possible to get a &T from &MutexGuard (via Deref).
impl<T> Sync for std::sync::poison::mutex::MutexGuard<'_, T>
T must be Sync for a MutexGuard<T> to be Sync
because it is possible to get a &T from &MutexGuard (via Deref).
impl<T> Sync for NonZero<T>where
T: ZeroablePrimitive + Sync,
impl<T> Sync for OffsetArc<T>
impl<T> Sync for OnceBox<T>
impl<T> Sync for OnceLock<T>
impl<T> Sync for Out<'_, T>where
T: Sync,
impl<T> Sync for RChunksExactMut<'_, T>where
T: Sync,
impl<T> Sync for RChunksMut<'_, T>where
T: Sync,
impl<T> Sync for std::sync::oneshot::Receiver<T>
impl<T> Sync for std::sync::mpmc::Receiver<T>where
T: Send,
impl<T> Sync for ReentrantLock<T>
impl<T> Sync for ReentrantLockGuard<'_, T>
impl<T> Sync for std::sync::nonpoison::rwlock::RwLock<T>
impl<T> Sync for std::sync::poison::rwlock::RwLock<T>
impl<T> Sync for std::sync::nonpoison::rwlock::RwLockReadGuard<'_, T>
impl<T> Sync for std::sync::poison::rwlock::RwLockReadGuard<'_, T>
impl<T> Sync for std::sync::nonpoison::rwlock::RwLockWriteGuard<'_, T>
impl<T> Sync for std::sync::poison::rwlock::RwLockWriteGuard<'_, T>
impl<T> Sync for ScopedKey<T>
impl<T> Sync for std::sync::oneshot::Sender<T>
impl<T> Sync for std::sync::mpmc::Sender<T>where
T: Send,
impl<T> Sync for std::sync::mpsc::Sender<T>where
T: Send,
impl<T> Sync for SyncUnsafeCell<T>
impl<T> Sync for SyncView<T>where
T: ?Sized,
impl<T> Sync for ThinBox<T>
ThinBox<T> is Sync if T is Sync because the data is owned.