Struct bevy_utils::syncunsafecell::SyncUnsafeCell

source ·
pub struct SyncUnsafeCell<T: ?Sized> { /* private fields */ }
Expand description

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§

source§

impl<T> SyncUnsafeCell<T>

source

pub const fn new(value: T) -> Self

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

source

pub fn into_inner(self) -> T

Unwraps the value.

source§

impl<T: ?Sized> SyncUnsafeCell<T>

source

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

source

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.

source

pub const fn raw_get(this: *const Self) -> *mut T

Gets a mutable pointer to the wrapped value.

See UnsafeCell::get for details.

source

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

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

source§

impl<T> SyncUnsafeCell<[T]>

source

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§

source§

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

source§

fn default() -> SyncUnsafeCell<T>

Creates an SyncUnsafeCell, with the Default value for T.

source§

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

source§

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

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

source§

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

Auto Trait Implementations§

§

impl<T> !Freeze for SyncUnsafeCell<T>

§

impl<T> !RefUnwindSafe for SyncUnsafeCell<T>

§

impl<T> Send for SyncUnsafeCell<T>
where T: Send + ?Sized,

§

impl<T> Unpin for SyncUnsafeCell<T>
where T: Unpin + ?Sized,

§

impl<T> UnwindSafe for SyncUnsafeCell<T>
where T: UnwindSafe + ?Sized,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> ConditionalSend for T
where T: Send,