Struct cryo::CryoMut

pub struct CryoMut<'a, T: ?Sized + 'a> { /* fields omitted */ }

A cell-like type that enforces the lifetime restriction of its borrowed value at runtime.

CryoMut is a variation of Cryo that can be mutably borrowed.

When a CryoMut is dropped, the current thread will be blocked until all references to the contained value are dropped. This ensures that none of the references can outlive the referent.

See the module-level documentation for more details.

Methods

impl<'a, T: ?Sized + 'a> CryoMut<'a, T>

pub unsafe fn new(x: &'a mut T) -> Self

Construct a new CryoMut.

Safety

• The constructed CryoMut must not be moved around. This might result in a dangling pointer in CryoMut*Guard.

• The constructed CryoMut must not be disposed without dropping (e.g., passed to std::mem::forget). This might result in a dangling pointer in CryoMut*Guard.

pub fn read(&self) -> CryoMutReadGuard<T>

Acquire a read (shared) lock on a CryoMut.

pub fn try_read(&self) -> Option<CryoMutReadGuard<T>>

Attempt to acquire a read (shared) lock on a CryoMut.

pub fn write(&self) -> CryoMutWriteGuard<T>

Acquire a write (exclusive) lock on a CryoMut.

pub fn try_write(&self) -> Option<CryoMutWriteGuard<T>>

Attempt to acquire a write (exclusive) lock on a CryoMut.

pub fn try_get_mut(&mut self) -> Option<&mut T>

Attempt to mutably borrow a CryoMut using compile-time lifetime rules.

Returns None if the CryoMut is already borrowed via CryoMutReadGuard or CryoMutWriteGuard.

Trait Implementations

impl<'a, T: ?Sized + Debug> Debug for CryoMut<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: ?Sized + 'a> Drop for CryoMut<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T: ?Sized + Send> Send for CryoMut<'a, T>

impl<'a, T: ?Sized + Send + Sync> Sync for CryoMut<'a, T>