Crates.io | sync-cell-slice |
lib.rs | sync-cell-slice |
version | 0.9.11 |
source | src |
created_at | 2024-11-26 21:33:20.579214 |
updated_at | 2024-11-27 07:40:17.703469 |
description | Cells and slices that are accessible from multiple threads |
homepage | |
repository | https://github.com/vigna/sync-cell-slice-rs/ |
max_upload_size | |
id | 1462351 |
size | 52,676 |
Sometimes, multiple threads need to access a place or an element of a slice without atomic operations because the absence of data races is guaranteed externally (e.g., each thread writes to a different element of the slice).
This small crate implements a solution based on a SyncCell<T>
newtype with
base type Cell<T>
. Contrarily to Cell<T>
, SyncCell<T>
can be shared
among threads, as long as its content can be shared, too. This result is
obtained by forcing Sync
on SyncCell<T>
if T
is Sync
.
All access methods are unsafe, because lack of external synchronization might
lead to data races, and thus to undefined behavior. Note that this approach is
radically different from that of SyncUnsafeCell
, all of which methods are
safe.
An important advantage of using Cell
instead of UnsafeCell
as base type
is that we can use the Cell::as_slice_of_cells
method to implement an
analogous method for SyncCell
that makes it possible to make SyncCell
and slices commute, that is, to obtain (safely) from a &SyncCell<[T]>
a
&[SyncCell<T>]
. Since SyncCell<T>
is Sync
if T
is, [SyncCell<T>]
is Sync
if T
is, too. Thus, if T
is Sync
sharing a slice of T
among threads is just a matter of wrapping the slice in a SyncCell
and
calling SyncCell::as_slice_of_cells
. This process is carried out by the
extension trait SyncSlice
, which adds to slices a method as_sync_slice
.
The design is based on suggestions in a post by Alice Ryhl and in this thread on the Rust Language Forum. Tommaso Fontana, Valentin Lorentz, and Stefano Zacchiroli provided comments on the design.
This software has been partially supported by project SERICS (PE00000014) under the NRRP MUR program funded by the EU - NGEU. Views and opinions expressed are however those of the authors only and do not necessarily reflect those of the European Union or the Italian MUR. Neither the European Union nor the Italian MUR can be held responsible for them.