Struct WriteLock 

pub struct WriteLock { /* private fields */ }

OS-level exclusive (write) lock on a file. Creates the file if it does not exist.

Implementations

impl WriteLock

pub fn new<P: AsRef<Path>>(path: P) -> Result<Self, LockError>

Acquire an exclusive lock on path. Returns LockError::Contention if any in-process holder is already present.

pub fn path(&self) -> &Path

pub fn file(&self) -> Option<&File>

pub fn file_mut(&mut self) -> Option<&mut File>

pub fn unlock(&mut self) -> Result<(), LockError>

pub fn restore_read_lock(self) -> Result<ReadLock, LockError>

Downgrade to a read lock by releasing the write lock and acquiring a fresh read lock.

Trait Implementations

impl Drop for WriteLock

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.