Struct OwnedFileLockGuard 

pub struct OwnedFileLockGuard { /* private fields */ }

A guard that owns its FileLock and releases the lock when dropped.

Unlike FileLockGuard, this guard does not borrow the FileLock, so it has no lifetime and can be stored in long-lived structures or moved across threads and tasks. It is returned by FileLock::lock_owned and related methods.

Implementations

impl OwnedFileLockGuard

pub fn file(&self) -> &File

Returns a reference to the underlying lock file.

This can be used to read or write auxiliary data stored in the lock file, such as the holder’s process id, while the lock is held.

On Rust 1.89 and newer the returned reference also exposes the standard library’s locking methods (such as File::unlock). Do not call them through this reference: they act on the same underlying lock and would release it while this guard still believes it is held.

pub fn unlock(self) -> Result<FileLock>

Manually unlocks the file lock, returning the FileLock for reuse.

If releasing the lock fails, the FileLock is dropped, which closes the lock file and thereby releases the lock anyway.

Trait Implementations

impl Drop for OwnedFileLockGuard

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.