Trait scale_info::prelude::marker::Sync
1.0.0 · source · 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.
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.
Implementors§
impl !Sync for Args
impl !Sync for ArgsOs
impl Sync for Bytes
impl Sync for BytesMut
impl Sync for scale_info::prelude::string::Drain<'_>
impl Sync for AtomicBool
impl Sync for AtomicI8
impl Sync for AtomicI16
impl Sync for AtomicI32
impl Sync for AtomicI64
impl Sync for AtomicIsize
impl Sync for AtomicU8
impl Sync for AtomicU16
impl Sync for AtomicU32
impl Sync for AtomicU64
impl Sync for AtomicUsize
impl Sync for Waker
impl<'a> Sync for IoSlice<'a>
impl<'a> Sync for IoSliceMut<'a>
impl<'a, T, const CAP: usize> Sync for arrayvec::arrayvec::Drain<'a, T, CAP>where
T: Sync,
impl<Dyn> Sync for DynMetadata<Dyn>where
Dyn: ?Sized,
impl<M, T, O> Sync for BitRef<'_, M, T, O>where
M: Mutability,
T: BitStore + Sync,
O: BitOrder,
impl<T> !Sync for *const Twhere
T: ?Sized,
impl<T> !Sync for *mut Twhere
T: ?Sized,
impl<T> !Sync for Rc<T>where
T: ?Sized,
impl<T> !Sync for alloc::rc::Weak<T>where
T: ?Sized,
impl<T> !Sync for Cell<T>where
T: ?Sized,
impl<T> !Sync for RefCell<T>where
T: ?Sized,
impl<T> !Sync for UnsafeCell<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 Receiver<T>
impl<T> !Sync for Sender<T>
impl<T> Sync for BitSpanError<T>where
T: BitStore,
impl<T> Sync for MisalignError<T>
impl<T> Sync for ThinBox<T>where
T: Sync + ?Sized,
ThinBox<T> is Sync if T is Sync because the data is owned.
impl<T> Sync for Cursor<'_, T>where
T: Sync,
impl<T> Sync for CursorMut<'_, T>where
T: Sync,
impl<T> Sync for scale_info::prelude::collections::linked_list::Iter<'_, T>where
T: Sync,
impl<T> Sync for scale_info::prelude::collections::linked_list::IterMut<'_, T>where
T: Sync,
impl<T> Sync for LinkedList<T>where
T: Sync,
impl<T> Sync for Arc<T>where
T: Sync + Send + ?Sized,
impl<T> Sync for alloc::sync::Weak<T>where
T: Sync + Send + ?Sized,
impl<T> Sync for SyncUnsafeCell<T>where
T: Sync + ?Sized,
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 core::slice::iter::IterMut<'_, 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 AtomicPtr<T>
impl<T> Sync for Exclusive<T>where
T: ?Sized,
impl<T> Sync for Mutex<T>where
T: Send + ?Sized,
impl<T> Sync for MutexGuard<'_, T>where
T: Sync + ?Sized,
impl<T> Sync for OnceLock<T>where
T: Sync + Send,
impl<T> Sync for RwLock<T>where
T: Send + Sync + ?Sized,
impl<T> Sync for RwLockReadGuard<'_, T>where
T: Sync + ?Sized,
impl<T> Sync for RwLockWriteGuard<'_, T>where
T: Sync + ?Sized,
impl<T> Sync for JoinHandle<T>
impl<T, A> Sync for scale_info::prelude::collections::vec_deque::Drain<'_, T, A>where
T: Sync,
A: Allocator + Sync,
impl<T, A> Sync for scale_info::prelude::vec::Drain<'_, T, A>where
T: Sync,
A: Sync + Allocator,
impl<T, A> Sync for scale_info::prelude::vec::IntoIter<T, A>where
T: Sync,
A: Allocator + Sync,
impl<T, F> Sync for LazyLock<T, F>where
F: Send,
OnceLock<T>: Sync,
impl<T, O> Sync for bitvec::boxed::iter::IntoIter<T, O>where
T: BitStore + Sync,
O: BitOrder,
impl<T, O> Sync for BitBox<T, O>where
T: BitStore,
O: BitOrder,
impl<T, O> Sync for bitvec::slice::iter::Iter<'_, T, O>where
T: BitStore,
O: BitOrder,
BitSlice<T, O>: Sync,
impl<T, O> Sync for bitvec::slice::iter::IterMut<'_, T, O>where
T: BitStore,
O: BitOrder,
BitSlice<T, O>: Sync,
impl<T, O> Sync for BitSlice<T, O>where
T: BitStore + Sync,
O: BitOrder,
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.