Struct FileLock 

pub struct FileLock { /* private fields */ }

File lock guard that can hold either a shared or exclusive OS lock.

Implementations

impl FileLock

pub fn open_and_lock(path: &Path) -> Result<(File, Self)>

Opens a file at path with read/write permissions and acquires an exclusive lock.

pub fn open_read_only(path: &Path) -> Result<(File, Self)>

Opens a file at path with read/write permissions and acquires a shared lock.

pub fn unlocked(file: &File) -> Result<Self>

Returns a non-locking guard for callers that only require a stable clone handle.

pub fn acquire(file: &File, _path: &Path) -> Result<Self>

Clones the provided file handle and locks it exclusively.

pub fn try_acquire(_file: &File, path: &Path) -> Result<Option<Self>>

Attempts a non-blocking exclusive lock, returning None if already locked.

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

Releases the underlying OS file lock.

pub fn clone_handle(&self) -> Result<File>

Exposes a clone of the locked handle for buffered operations.

pub fn mode(&self) -> LockMode

pub fn downgrade_to_shared(&mut self) -> Result<()>

pub fn upgrade_to_exclusive(&mut self) -> Result<()>

Trait Implementations

impl Drop for FileLock

fn drop(&mut self)

Executes the destructor for this type.