Struct bevy::utils::syncunsafecell::SyncUnsafeCell

pub struct SyncUnsafeCell<T>
where
    T: ?Sized,
{ /* private fields */ }

UnsafeCell, but Sync.

See tracking issue for upcoming native impl, which should replace this one entirely (except from_mut).

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

UnsafeCell doesn’t implement Sync, to prevent accidental misuse. 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(value: T) -> SyncUnsafeCell<T>

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

pub fn into_inner(self) -> T

Unwraps the value.

impl<T> SyncUnsafeCell<T>

where T: ?Sized,

pub const fn get(&self) -> *mut T

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 fn get_mut(&mut self) -> &mut T

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(this: *const SyncUnsafeCell<T>) -> *mut T

Gets a mutable pointer to the wrapped value.

See UnsafeCell::get for details.

pub fn from_mut(t: &mut T) -> &mut SyncUnsafeCell<T>

Returns a &mut SyncUnsafeCell<T> from a &mut T.

impl<T> SyncUnsafeCell<[T]>

pub fn as_slice_of_cells(&self) -> &[SyncUnsafeCell<T>]

Returns a &[SyncUnsafeCell<T>] from a &SyncUnsafeCell<[T]>.

Examples

let slice: &mut [i32] = &mut [1, 2, 3];
let cell_slice: &SyncUnsafeCell<[i32]> = SyncUnsafeCell::from_mut(slice);
let slice_cell: &[SyncUnsafeCell<i32>] = cell_slice.as_slice_of_cells();

assert_eq!(slice_cell.len(), 3);

Trait Implementations

impl<T> Default for SyncUnsafeCell<T>

where T: Default,

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> Sync for SyncUnsafeCell<T>

where T: Sync + ?Sized,