Struct core::cell::SyncUnsafeCell

#[repr(transparent)]
pub struct SyncUnsafeCell<T: ?Sized> { /* private fields */ }

🔬This is a nightly-only experimental API. (sync_unsafe_cell #95439)

UnsafeCell, but Sync.

This is just an UnsafeCell, except it implements Sync if T implements Sync.

UnsafeCell doesn’t implement Sync, to prevent accidental mis-use. You can use SyncUnsafeCell instead of UnsafeCell to allow it to be shared between threads, if that’s intentional. Providing proper synchronization is still the task of the user, making this type just as unsafe to use.

See UnsafeCell for details.

Implementations

impl<T> SyncUnsafeCell<T>

pub const fn new<const host: bool = true>(value: T) -> Self

🔬This is a nightly-only experimental API. (sync_unsafe_cell #95439)

Constructs a new instance of SyncUnsafeCell which will wrap the specified value.

pub const fn into_inner<const host: bool = true>(self) -> T

🔬This is a nightly-only experimental API. (sync_unsafe_cell #95439)

Unwraps the value, consuming the cell.

impl<T: ?Sized> SyncUnsafeCell<T>

pub const fn get<const host: bool = true>(&self) -> *mut T

🔬This is a nightly-only experimental API. (sync_unsafe_cell #95439)

Gets a mutable pointer to the wrapped value.

This can be cast to a pointer of any kind. Ensure that the access is unique (no active references, mutable or not) when casting to &mut T, and ensure that there are no mutations or mutable aliases going on when casting to &T

pub const fn get_mut<const host: bool = true>(&mut self) -> &mut T

🔬This is a nightly-only experimental API. (sync_unsafe_cell #95439)

Returns a mutable reference to the underlying data.

This call borrows the SyncUnsafeCell mutably (at compile-time) which guarantees that we possess the only reference.

pub const fn raw_get<const host: bool = true>(this: *const Self) -> *mut T

🔬This is a nightly-only experimental API. (sync_unsafe_cell #95439)

Gets a mutable pointer to the wrapped value.

See UnsafeCell::get for details.

Trait Implementations

impl<T: ?Sized> Debug for SyncUnsafeCell<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Default> Default for SyncUnsafeCell<T>

fn default() -> SyncUnsafeCell<T>

Creates an SyncUnsafeCell, with the Default value for T.

impl<T> From<T> for SyncUnsafeCell<T>

fn from(t: T) -> SyncUnsafeCell<T>

Creates a new SyncUnsafeCell<T> containing the given value.

impl<T: CoerceUnsized<U>, U> CoerceUnsized<SyncUnsafeCell<U>> for SyncUnsafeCell<T>

impl<T: DispatchFromDyn<U>, U> DispatchFromDyn<SyncUnsafeCell<U>> for SyncUnsafeCell<T>

impl<T: ?Sized + Sync> Sync for SyncUnsafeCell<T>