Struct loom::cell::CausalCell

pub struct CausalCell<T> { /* fields omitted */ }

CausalCell ensures access to the inner value are valid under the Rust memory model.

Methods

impl<T> CausalCell<T>

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

Construct a new instance of CausalCell which will wrap the specified value.

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_deferred<F, R>(&self, f: F) -> (R, CausalCheck) where
    F: FnOnce(*const T) -> R, 

Get an immutable pointer to the wrapped value, deferring the causality check.

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 with_deferred_mut<F, R>(&self, f: F) -> (R, CausalCheck) 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 with_unchecked<F, R>(&self, f: F) -> R where
    F: FnOnce(*const T) -> R, 

Get an immutable pointer to the wrapped value.

pub fn with_mut_unchecked<F, R>(&self, f: F) -> R where
    F: FnOnce(*mut T) -> R, 

Get a mutable pointer to the wrapped value.

pub fn check(&self)

Check that the current thread can make an immutable access without violating the Rust memory model.

Specifically, this function checks that there is no concurrent mutable access with this immutable access, while allowing many concurrent immutable accesses.

pub fn check_mut(&self)

Check that the current thread can make a mutable access without violating the Rust memory model.

Specifically, this function checks that there is no concurrent mutable access and no concurrent immutable access(es) with this mutable access.

Trait Implementations

impl<T: Debug> Debug for CausalCell<T>

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

Formats the value using the given formatter.