Struct loom::cell::UnsafeCell

pub struct UnsafeCell<T: ?Sized> { /* private fields */ }

A checked version of std::cell::UnsafeCell.

Instead of providing a get() API, this version of UnsafeCell provides with and with_mut. Both functions take a closure in order to track the start and end of the access to the underlying cell.

Implementations

impl<T> UnsafeCell<T>

pub fn new(data: T) -> UnsafeCell<T>

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

pub fn into_inner(self) -> T

Unwraps the value.

impl<T: ?Sized> UnsafeCell<T>

pub fn with<F, R>(&self, f: F) -> R

where F: FnOnce(*const T) -> R,

Get an immutable pointer to the wrapped value.

Panics

This function will panic if the access is not valid under the Rust memory model.

pub fn with_mut<F, R>(&self, f: F) -> R

where F: FnOnce(*mut T) -> R,

Get a mutable pointer to the wrapped value.

Panics

This function will panic if the access is not valid under the Rust memory model.

pub fn get(&self) -> ConstPtr<T>

Get an immutable pointer to the wrapped value.

This function returns a ConstPtr guard, which is analogous to a *const T, but tracked by Loom. As long as the returned ConstPtr exists, Loom will consider the cell to be accessed immutably.

This means that any mutable accesses (e.g. calls to with_mut or get_mut) while the returned guard is live will result in a panic.

Panics

This function will panic if the access is not valid under the Rust memory model.

pub fn get_mut(&self) -> MutPtr<T>

Get a mutable pointer to the wrapped value.

This function returns a MutPtr guard, which is analogous to a *mut T, but tracked by Loom. As long as the returned MutPtr exists, Loom will consider the cell to be accessed mutably.

This means that any concurrent mutable or immutable accesses (e.g. calls to with, with_mut, get, or get_mut) while the returned guard is live will result in a panic.

Panics

This function will panic if the access is not valid under the Rust memory model.

Trait Implementations

impl<T: Debug + ?Sized> Debug for UnsafeCell<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for UnsafeCell<T>

fn default() -> UnsafeCell<T>

Returns the “default value” for a type.

impl<T> From<T> for UnsafeCell<T>

fn from(src: T) -> UnsafeCell<T>

Converts to this type from the input type.