Struct OnceMutex

pub struct OnceMutex<T> { /* private fields */ }

A mutex which can only be locked once, but which provides very fast, lock-free, concurrent reads after the first lock is over.

Implementations

impl<T: Send + Sync> OnceMutex<T>

pub fn new(x: T) -> OnceMutex<T>

Create a new OnceMutex.

pub fn lock(&self) -> Option<OnceMutexGuard<'_, T>>

Attempt to lock the OnceMutex.

This will not block, but will return None if the OnceMutex has already been locked or is currently locked by another thread.

pub fn wait(&self)

Block the current task until the first lock is over.

Does nothing if there is no lock.

pub fn into_inner(self) -> T

Extract the data from a OnceMutex.

pub fn locked(&self) -> bool

Is this OnceMutex currently locked?

Trait Implementations

impl<T: Send + Sync> Deref for OnceMutex<T>

fn deref(&self) -> &T

Get a reference to the value inside the OnceMutex.

This can block if the OnceMutex is in its lock, but is very fast otherwise.

type Target = T

The resulting type after dereferencing.

impl<T: Send + Sync> DerefMut for OnceMutex<T>

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

Mutably dereferences the value.

impl<T: Send> Send for OnceMutex<T>

impl<T: Sync> Sync for OnceMutex<T>