Struct cryo::CryoMut

pub struct CryoMut<'a, T: ?Sized, Lock: Lock> { /* 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’s execution will be prevented from moving forward (at least) until all references to the expiring CryoMut are dropped. This ensures that none of the outstanding references can outlive the referent.

See the module-level documentation for more details.

Implementations

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

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

Construct a new CryoMut.

pub fn read(self: Pin<&Self>) -> CryoMutReadGuard<T, Lock>

Acquire a read (shared) lock on a CryoMut.

pub fn try_read(self: Pin<&Self>) -> Option<CryoMutReadGuard<T, Lock>>

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

pub fn write(self: Pin<&Self>) -> CryoMutWriteGuard<T, Lock>

Acquire a write (exclusive) lock on a CryoMut.

pub fn try_write(self: Pin<&Self>) -> Option<CryoMutWriteGuard<T, Lock>>

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

pub fn try_get_mut<'this>(self: Pin<&'this mut Self>) -> Option<&'this 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, Lock: Lock> Debug for CryoMut<'a, T, Lock>

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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

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