Struct FileHandle 

pub struct FileHandle { /* private fields */ }

A file handle with latch protection for thread-safe I/O.

The handle holds a file descriptor and an exclusive latch. All I/O operations must be performed while holding the latch.

Implementations

impl FileHandle

pub fn new(file_num: u32) -> Self

Creates a new uninitialized file handle.

The file must be initialized via init() before use.

pub fn init(&mut self, file: File, log_version: u32)

Initializes the handle with an open file and log version.

pub fn file_num(&self) -> u32

Returns the file number.

pub fn log_version(&self) -> u32

Returns the log version.

pub fn is_initialized(&self) -> bool

Returns true if the file is initialized.

pub fn acquire(&self) -> Result<FileHandleGuard<'_>>

Acquires the latch and returns a guard that provides access to the file.

Returns Ok(guard) on success, or Err(LogError::LatchTimeout) if the latch acquisition times out. The latch is released when the guard drops.

pub fn try_acquire(&self) -> Option<FileHandleGuard<'_>>

Attempts to acquire the latch without blocking.

Returns None if the latch is currently held.

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

Closes the file handle.

This should only be called when the handle is no longer in use.

Trait Implementations

impl Drop for FileHandle

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.