Struct yaque::mutex::Mutex

pub struct Mutex { /* private fields */ }

A persistent mutex implementation using the atomicity of OpenOptions::create_new. This structure, as opposed to FileGuard, holds some content in a separate file.

Implementations

impl Mutex

pub fn open<P: AsRef<Path>>(path: P) -> Result<Mutex>

Opens a new mutex, given the path for a folder in which the mutex will be mounted. This will create a new folder if one does not exist yet.

Errors

This function fails if it cannot create the folder which is going to contain the mutex.

pub async fn lock(&self) -> Result<MutexGuard>

Locks this mutex, awaiting for it to unlock if it is locked.

pub fn try_lock(&self) -> Result<Option<MutexGuard>>

Tries to lock this mutex, returning None if it is locked.