Struct FileLock 

pub struct FileLock { /* private fields */ }

File lock guard that automatically releases the lock when dropped

Implementations

impl FileLock

pub fn lock(file: File, lock_type: LockType) -> Result<Self>

Acquire a file lock (blocking)

This will block until the lock can be acquired.

Platform Support

• Unix: Uses flock(2)
• Windows: Uses LockFile/LockFileEx

Examples

use mmap_rs::{FileLock, LockType};
use std::fs::File;

let file = File::open("data.bin")?;
let lock = FileLock::lock(file, LockType::Shared)?;
// File is locked for reading
// Lock automatically released when `lock` is dropped

pub fn try_lock(file: File, lock_type: LockType) -> Result<Self>

Try to acquire a file lock (non-blocking)

Returns immediately if the lock cannot be acquired.

Examples

use mmap_rs::{FileLock, LockType};
use std::fs::File;

let file = File::open("data.bin")?;
match FileLock::try_lock(file, LockType::Exclusive) {
    Ok(lock) => {
        // Got the lock
    }
    Err(_) => {
        // Lock not available
    }
}

pub fn file(&self) -> &File

Get a reference to the underlying file

pub fn lock_type(&self) -> LockType

Get the lock type

pub fn unlock(self) -> File

Unlock and consume the lock guard, returning the file

Trait Implementations

impl Drop for FileLock

fn drop(&mut self)

Executes the destructor for this type.

impl Send for FileLock